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 ikiwiki package includes some standard plugins that are installed and
   4 by default. These include [[inline]], [[pagecount]], and [[brokenlinks]], and [[search]]. Of these, [[inline]] is enabled by default.
   5
   6 To enable other plugins, use the `--plugin` switch described in [[usage]],
   7 or the equivalent line in [[ikiwiki.setup]].
   8
   9 ## Plugin directory
  10
  11 Add your contributed plugins here.
  12
  13 [[inline pages="plugins/* !plugins/write !*/Discussion" archive="yes" rootpage="plugins/contrib" show="30"]]
  14
  15 ## Installing third party plugins
  16
  17 Plugins are perl modules and should be installed somewhere in the perl
  18 module search path. See the @INC list at the end of the output of `perl -V`
  19 for a list of the directories in that path. All plugins are in the
  20 IkiWiki::Plugin namespace, so they go in a IkiWiki/Plugin subdirectory
  21 inside the perl search path. For example, if your perl looks in
  22 `/usr/local/lib/site_perl` for modules, you can locally install ikiwiki
  23 plugins to `/usr/local/lib/site_perl/IkiWiki/Plugin`