aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/listdirectives.mdwn
blob: df854de52ecc78bd120e0f00606f2461608ff7b5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
[[!template id=plugin name=listdirectives author="Will"]]
[[!tag type/meta]]
[[!tag type/widget]]

This plugin provides the [[ikiwiki/directive/listdirectives]]
[[ikiwiki/directive]], which inserts a list of currently available
directives into the page.

Each directive links to a wiki page with the same name, that should
document that directive. The location of these pages can be controlled via
the `directive_description_dir` setting in the setup file, the default is
"ikiwiki/directive/foo".

When this plugin is enabled, it enables the directives underlay, which
contains documentation about all the directives included in plugins shipped
with ikiwiki. This adds about 200 kb to the size of your wiki.