X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/75f905a18aa68975c4194386302e7a1d223a4d87..623c7e17989f53ef049f12639950d2c50c9edd4f:/doc/plugins/mdwn.mdwn?ds=sidebyside diff --git a/doc/plugins/mdwn.mdwn b/doc/plugins/mdwn.mdwn index 6b20b7bb0..e22f68eda 100644 --- a/doc/plugins/mdwn.mdwn +++ b/doc/plugins/mdwn.mdwn @@ -7,6 +7,8 @@ It uses the [[ikiwiki/markdown]] minimal markup language. This is the standard markup language used by ikiwiki, although some others are also available in other plugins. +## Implementations + There are several implementations of markdown support that can be used by this plugin. In order of preference: @@ -27,3 +29,22 @@ in the setup file. Note that multimarkdown's metadata and wikilinks 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. + + +## Advanced options + +* `nodiscount`: If set to 1, Text::Markdown::Discount will not be used + even if it is available. The default is to use Discount if available, + and this is recommended. +* `multimarkdown`: If set to 1, Text::MultiMarkdown will be used in + preference to Text::Markdown::Discount. The default is to not use + MultiMarkdown, and this is recommended. +* `mdwn_footnotes`: If set to 1, implementations that support it will + recognise the footnote syntax originating in PHP Markdown Extra, with + `Footnote reference[^1]` and `[^1]: Footnote definition`. The default + is 1. +* `mdwn_alpha_lists`: If set to 1, Text::Markdown::Discount will + accept letters as well as numbers in ordered list markers. The + default is 0, to avoid unintended parsing of lines that happen + to begin with a letter and a dot, such as "C. S. Lewis was an + author" or "M. Descartes was a philosopher".