doc/plugins/mdwn.mdwn

   1 [[!template id=plugin name=mdwn core=1 author="[[Joey]]"]]
   2 [[!tag type/format]]
   3
   4 This plugin lets ikwiki convert files with names ending in ".mdwn" to html.
   5 It uses the [[ikiwiki/markdown]] minimal markup language.
   6
   7 This is the standard markup language used by ikiwiki, although some others
   8 are also available in other plugins.
   9
  10 There are several implementations of markdown support that can be used by
  11 this plugin. In order of preference:
  12
  13 * [Discount](http://www.pell.portland.or.us/~orc/Code/discount/),
  14   via the [[!cpan Text::Markdown::Discount]] perl module.
  15   This implementation is considered to be the default and is strongly
  16   recommended, but it is not mandatory because it requires an external
  17   C library.
  18 * The [[!cpan Text::Markdown]] perl module.
  19 * The [original version of markdown](http://daringfireball.net/projects/markdown/).
  20
  21 [[!cpan Text::MultiMarkdown]] can be used in order to use tables, footnotes,
  22 and other new features from the markdown variant called
  23 [multimarkdown](http://fletcherpenney.net/MultiMarkdown/) (some of which
  24 are also available in the recommended implementation, Discount). Multimarkdown is
  25 not enabled by default, but can be turned on via the `multimarkdown` option
  26 in the setup file. Note that multimarkdown's metadata and wikilinks
  27 features are disabled when it's used with ikiwiki. Also note that if the
  28 `multimarkdown` option is enabled, it takes priority over Discount, which
  29 might cause formatting that is understood by Discount to be ignored.