X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/3cb1c8fa3b1fac58f8a84deef9b72b334c17c97a..8ded9f57a12a27fa5fc1e272ec7b2d2a5aa28419:/doc/plugins/listdirectives.mdwn diff --git a/doc/plugins/listdirectives.mdwn b/doc/plugins/listdirectives.mdwn index 3645813b8..2d9bce01d 100644 --- a/doc/plugins/listdirectives.mdwn +++ b/doc/plugins/listdirectives.mdwn @@ -1,11 +1,15 @@ [[!template id=plugin name=listdirectives author="Will"]] [[!tag type/meta]] -This plugin generates a list of available -[[directives|ikiwiki/directive]]. +This plugin provides the [[ikiwiki/directive/listdirectives]] +[[ikiwiki/directive]], which inserts a list of currently available +directives into the page. - \[[!listdirectives]] +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". -Each directive links to a wiki page with the same name. The location of the -pages in the wiki can be controlled via the `directive_description_dir` -setting in the setup file. +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.