diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ikiwiki.setup | 2 | ||||
| -rw-r--r-- | doc/plugins/mdwn.mdwn | 12 | ||||
| -rw-r--r-- | doc/todo/Support__47__Switch_to_MultiMarkdown.mdwn | 3 |
3 files changed, 17 insertions, 0 deletions
diff --git a/doc/ikiwiki.setup b/doc/ikiwiki.setup index e85518849..7813eb822 100644 --- a/doc/ikiwiki.setup +++ b/doc/ikiwiki.setup @@ -133,6 +133,8 @@ use IkiWiki::Setup::Standard { # Attempt to make hardlinks to source files instead of copying them. # Useful if the wiki contains large media files. #hardlink => 1, + # Enable use of multimarkdown features in .mdwn files. + #multimarkdown => 1, # To add plugins, list them here. #add_plugins => [qw{goodstuff search wikitext camelcase diff --git a/doc/plugins/mdwn.mdwn b/doc/plugins/mdwn.mdwn index c7c0ac7ce..07b59c3cf 100644 --- a/doc/plugins/mdwn.mdwn +++ b/doc/plugins/mdwn.mdwn @@ -6,3 +6,15 @@ 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. The [original version of +markdown](http://daringfireball.net/projects/markdown/) can be used, or the +[[cpan Text::Markdown]] perl module. + +[[cpan Text::Markdown]] also includes a markdown varient called +[multimarkdown](http://fletcherpenney.net/MultiMarkdown/), which supports +tables, footnotes, and other new features. 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. diff --git a/doc/todo/Support__47__Switch_to_MultiMarkdown.mdwn b/doc/todo/Support__47__Switch_to_MultiMarkdown.mdwn index 732de0bdf..2d22de2c0 100644 --- a/doc/todo/Support__47__Switch_to_MultiMarkdown.mdwn +++ b/doc/todo/Support__47__Switch_to_MultiMarkdown.mdwn @@ -30,3 +30,6 @@ MultiMarkdown would solve the BibTex request and the multiple output formats wou > Unless there's a way to disable a zillion of the features, please **no**. Do _not_ switch to it. One thing that I like about markdown as opposed to most other ASCII markup languages, is that it has at least a bit of moderation on the syntax (although it could be even simpler). There's not a yet another reserved character lurking behind every corner. Not so in multimarkdown anymore. Footnotes, bibliography and internal references I could use, and they do not add any complex syntax: it's all inside the already reserved sequences of bracketed stuff. (If you can even say that ASCII markup languages have reserved sequences, as they randomly decide to interpret stuff, never actually failing on illegal input, like a proper language to write any serious documentation in, would do.) But tables, math, and so on, no thanks! Too much syntax! Syntax overload! Bzzzt! I don't want mischievous syntaxes lurking behind every corner, out to get me. --[[tuomov]] > ikiwiki already supports MultiMarkdown, since it has the same API as MarkDown. So if you install it as Markdown.pm (or as /usr/bin/markdown), it should Just Work. It would also be easy to support some other extension such as mmdwn to use multimarkdown installed as MuliMarkdown.pm, if someone wanted to do that for some reason -- just copy the mdwn plugin and lightly modify. --[[Joey]] + +> There's now a multimarkdown setup file option that uses +> Text::MultiMarkdown for .mdwn files. [[done]] --[[Joey]] |