aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/autoindex.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'doc/plugins/autoindex.mdwn')
-rw-r--r--doc/plugins/autoindex.mdwn10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/plugins/autoindex.mdwn b/doc/plugins/autoindex.mdwn
new file mode 100644
index 000000000..e1cfe1157
--- /dev/null
+++ b/doc/plugins/autoindex.mdwn
@@ -0,0 +1,10 @@
+[[!template id=plugin name=autoindex core=0 author="[[Joey]]"]]
+[[!tag type/special-purpose]]
+
+This plugin searches for [[SubPages|ikiwiki/subpage]] with a missing parent
+page, and generates the parent pages. The generated page content is
+controlled by the `autoindex.tmpl` [[template|templates]], which by
+default, uses a [[map]] to list the SubPages.
+
+The `autoindex_commit` setting is enabled by default, and causes
+pages generated by autoindex to be checked into version control.