aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/map.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'doc/plugins/map.mdwn')
-rw-r--r--doc/plugins/map.mdwn11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn
new file mode 100644
index 000000000..b164d5ca8
--- /dev/null
+++ b/doc/plugins/map.mdwn
@@ -0,0 +1,11 @@
+[[!template id=plugin name=map author="Alessandro Dotti Contra"]]
+[[!tag type/meta type/widget]]
+
+This plugin provides the [[ikiwiki/directive/map]] [[ikiwiki/directive]],
+which generates a hierarchical page map for the wiki.
+
+[[!if test="enabled(map)" then="""
+Here's an example map, for the plugins section of this wiki:
+
+[[!map pages="(plugins or plugins/*) and !*/*/*"]]
+"""]]