X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/f398ad035b973608d380c9939ea845d8e2a0cdc2..75f905a18aa68975c4194386302e7a1d223a4d87:/doc/plugins/mdwn.mdwn diff --git a/doc/plugins/mdwn.mdwn b/doc/plugins/mdwn.mdwn index ce1b6097a..6b20b7bb0 100644 --- a/doc/plugins/mdwn.mdwn +++ b/doc/plugins/mdwn.mdwn @@ -8,13 +8,22 @@ This is the standard markup language used by ikiwiki, although some others are also available in other plugins. There are several implementations of markdown support that can be used by -this plugin. The [original version of -markdown](http://daringfireball.net/projects/markdown/) can be used, or the -[[!cpan Text::Markdown]] perl module. +this plugin. In order of preference: + +* [Discount](http://www.pell.portland.or.us/~orc/Code/discount/), + via the [[!cpan Text::Markdown::Discount]] perl module. + This implementation is considered to be the default and is strongly + recommended, but it is not mandatory because it requires an external + C library. +* The [[!cpan Text::Markdown]] perl module. +* The [original version of markdown](http://daringfireball.net/projects/markdown/). [[!cpan Text::MultiMarkdown]] can be used in order to use tables, footnotes, and other new features from the markdown variant called -[multimarkdown](http://fletcherpenney.net/MultiMarkdown/). Multimarkdown is +[multimarkdown](http://fletcherpenney.net/MultiMarkdown/) (some of which +are also available in the recommended implementation, Discount). Multimarkdown is not enabled by default, but can be turned on via the `multimarkdown` option in the setup file. Note that multimarkdown's metadata and wikilinks -features are disabled when it's used with ikiwiki. +features are disabled when it's used with ikiwiki. Also note that if the +`multimarkdown` option is enabled, it takes priority over Discount, which +might cause formatting that is understood by Discount to be ignored.