aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJoey Hess <joey@kitenet.net>2012-01-01 16:56:32 -0400
committerJoey Hess <joey@kitenet.net>2012-01-01 17:28:31 -0400
commit9dce803faf4dac9ee9249a108e9054e296e1f741 (patch)
tree389b67c066d6ec833d9bf2364bf67588591527e8 /doc
parent28e66cd34a157f31012e6b0be4afa2457a0c9f08 (diff)
downloadikiwiki-9dce803faf4dac9ee9249a108e9054e296e1f741.tar
ikiwiki-9dce803faf4dac9ee9249a108e9054e296e1f741.tar.gz
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.
Diffstat (limited to 'doc')
-rw-r--r--doc/plugins/mdwn.mdwn9
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/plugins/mdwn.mdwn b/doc/plugins/mdwn.mdwn
index ce1b6097a..8a7308305 100644
--- a/doc/plugins/mdwn.mdwn
+++ b/doc/plugins/mdwn.mdwn
@@ -8,9 +8,12 @@ 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.
+* 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