aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/graphviz.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'doc/plugins/graphviz.mdwn')
-rw-r--r--doc/plugins/graphviz.mdwn9
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/plugins/graphviz.mdwn b/doc/plugins/graphviz.mdwn
index 51b06ebab..b89f16b59 100644
--- a/doc/plugins/graphviz.mdwn
+++ b/doc/plugins/graphviz.mdwn
@@ -1,7 +1,7 @@
[[!template id=plugin name=graphviz author="[[JoshTriplett]]"]]
[[!tag type/chrome type/format]]
-This plugin implements the [[ikiwiki/directive/graph]] [[ikiwiki/directive]].
+This plugin provides the [[ikiwiki/directive/graph]] [[ikiwiki/directive]].
This directive allows embedding [graphviz](http://www.graphviz.org/) graphs in a
page.
@@ -15,4 +15,11 @@ already do these things with just the core of ikiwiki, but the graphviz plugin
allows for an amplification attack, since users can send less data to use large
amounts of processing time and disk usage.
+[[!if test="enabled(graphviz)" then="""
+Some example graphs:
+
+[[!graph src="a -> b -> c; a -> b;"]]
+[[!graph src="a -- b -- c -- a;" prog="circo" type="graph"]]
+"""]]
+
This plugin uses the [[!cpan Digest::SHA1]] perl module.