aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/toc.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'doc/plugins/toc.mdwn')
-rw-r--r--doc/plugins/toc.mdwn13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/plugins/toc.mdwn b/doc/plugins/toc.mdwn
new file mode 100644
index 000000000..57bd622ba
--- /dev/null
+++ b/doc/plugins/toc.mdwn
@@ -0,0 +1,13 @@
+[[template id=plugin name=toc included=1 author="Joey Hess"]]
+[[tag type/chrome]]
+
+Add a table of contents be to a page:
+
+ \[[toc ]]
+
+The table of contents will be automatically generated based on the
+headers of the page. By default only the largest headers present on the
+page will be shown; to control how many levels of headers are shown, use
+the `levels` parameter:
+
+ \[[toc levels=2]]