summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/plugins/linkmap.mdwn12
1 files changed, 9 insertions, 3 deletions
diff --git a/doc/plugins/linkmap.mdwn b/doc/plugins/linkmap.mdwn
index b52a87da9..89cb9d8ae 100644
--- a/doc/plugins/linkmap.mdwn
+++ b/doc/plugins/linkmap.mdwn
@@ -2,6 +2,12 @@
[[!tag type/meta]]
[[!tag type/slow]]
-This plugin implements the [[ikiwiki/directive/linkmap]] [[ikiwiki/directive]].
-The directive uses [graphviz](http://www.graphviz.org/) to generate a graph showing the links between a
-set of pages in the wiki.
+This plugin provides the [[ikiwiki/directive/linkmap]] [[ikiwiki/directive]].
+It uses [graphviz](http://www.graphviz.org/) to generate a graph showing the
+links between a set of pages in the wiki.
+
+[[!if test="enabled(linkmap)" then="""
+Here is an example link map, of the index page and all pages it links to:
+
+[[!linkmap pages="index or (backlink(index) and !*.png)"]]
+"""]]