doc/plugins.mdwn

   1 Most of ikiwiki's [[features]] are implemented as plugins. Beyond the
   2 [[type/core]] features, there are plugins to [[type/format]] text,
   3 use [[type/tags]], show [[type/meta]] information, do other [[type/useful]]
   4 stuff, or just have [[type/fun]].
   5
   6 There's documentation if you want to [[write]] your own plugins, or you can
   7 install and use plugins contributed by others.
   8
   9 The [[mdwn]], [[inline]], and [[htmlscrubber]] plugins are enabled by default.
  10
  11 To enable other plugins, use the `--plugin` switch described in [[usage]],
  12 or the equivalent `add_plugins` line in [[ikiwiki.setup]].
  13
  14 # Plugin directory
  15
  16 Add all plugins here. Or add ideas to the [[todo|todo/plugin]] page.
  17
  18 [[inline pages="plugins/* !plugins/type/* !plugins/write !*/Discussion" archive="yes" rootpage="plugins/contrib" show="60"]]
  19
  20 # Installing third party plugins
  21
  22 Plugins are perl modules and should be installed somewhere in the perl
  23 module search path. See the @INC list at the end of the output of `perl -V`
  24 for a list of the directories in that path. All plugins are in the
  25 IkiWiki::Plugin namespace, so they go in a IkiWiki/Plugin subdirectory
  26 inside the perl search path. For example, if your perl looks in
  27 `/usr/local/lib/site_perl` for modules, you can locally install ikiwiki
  28 plugins to `/usr/local/lib/site_perl/IkiWiki/Plugin`