doc/plugins.mdwn

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