aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/linkmap.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'doc/plugins/linkmap.mdwn')
-rw-r--r--doc/plugins/linkmap.mdwn14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/plugins/linkmap.mdwn b/doc/plugins/linkmap.mdwn
new file mode 100644
index 000000000..7e51cd935
--- /dev/null
+++ b/doc/plugins/linkmap.mdwn
@@ -0,0 +1,14 @@
+[[!template id=plugin name=linkmap author="[[Joey]]"]]
+[[!tag type/meta]]
+[[!tag type/widget]]
+[[!tag type/slow]]
+
+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)"]]
+"""]]