doc/plugins/listdirectives.mdwn

   1 [[!template id=plugin name=listdirectives author="Will"]]
   2 [[!tag type/meta]]
   3 [[!tag type/widget]]
   4
   5 This plugin provides the [[ikiwiki/directive/listdirectives]]
   6 [[ikiwiki/directive]], which inserts a list of currently available
   7 directives into the page.
   8
   9 Each directive links to a wiki page with the same name, that should
  10 document that directive. The location of these pages can be controlled via
  11 the `directive_description_dir` setting in the setup file, the default is
  12 "ikiwiki/directive/foo".
  13
  14 When this plugin is enabled, it enables the directives underlay, which
  15 contains documentation about all the directives included in plugins shipped
  16 with ikiwiki. This adds about 200 kb to the size of your wiki.