summaryrefslogtreecommitdiff
path: root/underlays/basewiki/directive/listdirectives.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'underlays/basewiki/directive/listdirectives.mdwn')
-rw-r--r--underlays/basewiki/directive/listdirectives.mdwn16
1 files changed, 16 insertions, 0 deletions
diff --git a/underlays/basewiki/directive/listdirectives.mdwn b/underlays/basewiki/directive/listdirectives.mdwn
new file mode 100644
index 000000000..4d7ab5b3e
--- /dev/null
+++ b/underlays/basewiki/directive/listdirectives.mdwn
@@ -0,0 +1,16 @@
+The `listdirectives` directive is supplied by the [[!iki plugins/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.