summaryrefslogtreecommitdiff
path: root/ikiwiki/directive/listdirectives.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'ikiwiki/directive/listdirectives.mdwn')
-rw-r--r--ikiwiki/directive/listdirectives.mdwn21
1 files changed, 21 insertions, 0 deletions
diff --git a/ikiwiki/directive/listdirectives.mdwn b/ikiwiki/directive/listdirectives.mdwn
new file mode 100644
index 0000000..0b5047d
--- /dev/null
+++ b/ikiwiki/directive/listdirectives.mdwn
@@ -0,0 +1,21 @@
+The `listdirectives` directive is supplied by the [[!iki
+plugins/listdirectives desc=listdirectives]] plugin.
+
+This directive generates a list of available
+[[directives|ikiwiki/directive]].
+
+ \[[!listdirectives]]
+
+There is one optional keyword argument, `generated`. Normally the
+`listdirectives` directive will list all built in directives and directives
+directly registered by plugins. With this keyword, `listdirectives` will
+also list directives generated later. For example, all [[shortcuts]] are
+directives generated in turn by the `shortcut` directive. They will only be
+listed if the `generated` argument is supplied.
+
+ \[[!listdirectives generated]]
+
+This extended list is often quite long, and often contains many undocumented
+directives.
+
+[[!meta robots="noindex, follow"]]