]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins/mdwn.mdwn
add YAML::XS dep to Makefile.PL
[git.ikiwiki.info.git] / doc / plugins / mdwn.mdwn
index 0e09812b2c5120d58b9f5663341f0494624d8463..8a7308305b611677ef482b332d8742cdf9a3fcb1 100644 (file)
@@ -1,3 +1,23 @@
-This plugin, which is enabled by default, lets ikwiki convert files with
-names ending in ".mdwn" to html. It uses the [[markdown]] minimal markup
-language.
+[[!template id=plugin name=mdwn core=1 author="[[Joey]]"]]
+[[!tag type/format]]
+
+This plugin lets ikwiki convert files with names ending in ".mdwn" to html.
+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.
+
+There are several implementations of markdown support that can be used by
+this plugin. In order of preference:
+
+* [Discount](http://www.pell.portland.or.us/~orc/Code/discount/),
+  via the [[!cpan Text::Markdown::Discount]] perl module.
+* 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
+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.