aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorsmcv <smcv@web>2017-05-14 07:51:56 -0400
committeradmin <admin@branchable.com>2017-05-14 07:51:56 -0400
commit65fe86e6f3544912d0fd64753aea2c5d61018e0e (patch)
tree44162248f422039cce5e99888e294f5c3c1df9c8 /doc
parentb14e3456ddab67cde270080e01c473fc96dac5be (diff)
downloadikiwiki-65fe86e6f3544912d0fd64753aea2c5d61018e0e.tar
ikiwiki-65fe86e6f3544912d0fd64753aea2c5d61018e0e.tar.gz
recommend discount over multimarkdown
Diffstat (limited to 'doc')
-rw-r--r--doc/plugins/mdwn.mdwn7
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/plugins/mdwn.mdwn b/doc/plugins/mdwn.mdwn
index 8a7308305..62d97b187 100644
--- a/doc/plugins/mdwn.mdwn
+++ b/doc/plugins/mdwn.mdwn
@@ -12,6 +12,9 @@ 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/).
@@ -20,4 +23,6 @@ and other new features from the markdown variant called
[multimarkdown](http://fletcherpenney.net/MultiMarkdown/). 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.