ikiwiki/doc/plugins/mdwn.mdwn

[[!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.
Migrate doc/plugins via prefix_directives This is a partial commit of: egrep -rl '\[\[[a-z]+ ' doc \| xargs --max-args 1 ./ikiwiki-transition prefix_directives 2008-07-21 13:31:57 +02:00			`[[!template id=plugin name=mdwn core=1 author="[[Joey]]"]]`
			`[[!tag type/format]]`
* Allow preprocessor directives to contain python-like triple-quoted text blocks, for easy nesting of quotes inside. * Add a template plugin. * Use the template plugin to add infoboxes to each plugin page listing basic info about the plugin. 2006-08-23 07:41:07 +02:00
			`This plugin lets ikwiki convert files with names ending in ".mdwn" to html.`
MAJOR basewiki reorg Including redir pages for the moved basewiki pages. These will be removed in a future release. 2007-12-08 21:59:08 +01:00			`It uses the [[ikiwiki/markdown]] minimal markup language.`
* Allow preprocessor directives to contain python-like triple-quoted text blocks, for easy nesting of quotes inside. * Add a template plugin. * Use the template plugin to add infoboxes to each plugin page listing basic info about the plugin. 2006-08-23 07:41:07 +02:00
			`This is the standard markup language used by ikiwiki, although some others`
			`are also available in other plugins.`
mdwn: Add a multimarkdown setup file option. 2008-05-13 18:43:25 +02:00
			`There are several implementations of markdown support that can be used by`
discount support mdwn: Can use the discount markdown library, via the Text::Markdown::Discount perl module. This is preferred if available since it's the fastest currently supported markdown library, speeding up markdown rendering by a factor of 40. That is to say, when only rendering a lot of markdown, discount is 40x faster. When building a ikiwiki site, ikiwiki's other overhead gets in the way, but I still see significant speedups. Building the ikiwiki docwiki dropped from 62 to 45 seconds, for example. However, when multimarkdown is enabled, Text::Markdown::Multimarkdown is still used. While discount contains some nonstandard markdown extensions, including tables and footnotes, AFAICS most of them are not enabled by default in the perl bindings. I consider sticking to non-extended markdown a desirable thing, since this is probably not the last markdown engine. In particular, sundown is waiting in the wings to get packaged and get a perl binding. ---- Reviewing all the showdown extensions, here are the ones that are enabled: centered paragraphs: ->centered<- image sizes: [dust mite](http://dust.mite =150x150) <style>..</style> blocks are eaten. The perl binding does not provide access to the gathered CSS. This is not legal html anyway, so unlikely to cause breakage. 2012-01-01 21:56:32 +01:00			`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/).`
mdwn: Add a multimarkdown setup file option. 2008-05-13 18:43:25 +02:00
update for Text::MultiMarkdown split 2009-08-31 01:17:45 +02:00			`[[!cpan Text::MultiMarkdown]] can be used in order to use tables, footnotes,`
			`and other new features from the markdown variant called`
remove ^P's 2009-09-01 01:30:31 +02:00			`[multimarkdown](http://fletcherpenney.net/MultiMarkdown/). Multimarkdown is`
update for Text::MultiMarkdown split 2009-08-31 01:17:45 +02:00			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.`