<!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>mdwn</title> <meta name="viewport" content="width=device-width, initial-scale=1" /> <link rel="stylesheet" href="../style.css" type="text/css" /> <link rel="stylesheet" href="../local.css" type="text/css" /> </head> <body> <div class="page"> <div class="pageheader"> <div class="header"> <span> <span class="parentlinks"> <a href="../index.html">ikiwiki</a>/ <a href="../plugins.html">plugins</a>/ </span> <span class="title"> mdwn </span> </span> </div> </div> <div id="pagebody"> <div id="content" role="main"> <p><span class="infobox"> Plugin: mdwn<br /> Author: <span class="createlink">Joey</span><br /> Included in ikiwiki: yes<br /> Enabled by default: yes<br /> Included in <a href="./goodstuff.html">goodstuff</a>: no<br /> Currently enabled: yes<br /> </span></p> <p>This plugin lets ikwiki convert files with names ending in ".mdwn" to html. It uses the <a href="../ikiwiki/markdown.html">markdown</a> minimal markup language.</p> <p>This is the standard markup language used by ikiwiki, although some others are also available in other plugins.</p> <h2>Implementations</h2> <p>There are several implementations of markdown support that can be used by this plugin. In order of preference:</p> <ul> <li><a href="http://www.pell.portland.or.us/~orc/Code/discount/">Discount</a>, via the <a href="http://search.cpan.org/search?mode=dist&query=Text%3A%3AMarkdown%3A%3ADiscount">Text::Markdown::Discount</a> 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.</li> <li>The <a href="http://search.cpan.org/search?mode=dist&query=Text%3A%3AMarkdown">Text::Markdown</a> perl module.</li> <li>The <a href="http://daringfireball.net/projects/markdown/">original version of markdown</a>.</li> </ul> <p><a href="http://search.cpan.org/search?mode=dist&query=Text%3A%3AMultiMarkdown">Text::MultiMarkdown</a> can be used in order to use tables, footnotes, and other new features from the markdown variant called <a href="http://fletcherpenney.net/MultiMarkdown/">multimarkdown</a> (some of which are also available in the recommended implementation, Discount). Multimarkdown is not enabled by default, but can be turned on via the <code>multimarkdown</code> option in the setup file. Note that multimarkdown's metadata and wikilinks features are disabled when it's used with ikiwiki. Also note that if the <code>multimarkdown</code> option is enabled, it takes priority over Discount, which might cause formatting that is understood by Discount to be ignored.</p> <h2>Advanced options</h2> <ul> <li><code>nodiscount</code>: If set to 1, Text::Markdown::Discount will not be used even if it is available. The default is to use Discount if available, and this is recommended.</li> <li><code>multimarkdown</code>: If set to 1, Text::MultiMarkdown will be used in preference to Text::Markdown::Discount. The default is to not use MultiMarkdown, and this is recommended.</li> <li><code>mdwn_footnotes</code>: If set to 1, implementations that support it will recognise the footnote syntax originating in PHP Markdown Extra, with <code>Footnote reference[^1]</code> and <code>[^1]: Footnote definition</code>. The default is 1.</li> <li><code>mdwn_alpha_lists</code>: If set to 1, Text::Markdown::Discount will accept letters as well as numbers in ordered list markers. The default is 0, to avoid unintended parsing of lines that happen to begin with a letter and a dot, such as "C. S. Lewis was an author" or "M. Descartes was a philosopher".</li> </ul> </div> </div> <div id="footer" class="pagefooter" role="contentinfo"> <div id="pageinfo"> <div class="tags"> Tags: <a href="./type/core.html" rel="tag">plugins/type/core</a> <a href="./type/format.html" rel="tag">type/format</a> </div> <div id="backlinks"> Links: <a href="./contrib/bootstrap.html">contrib/bootstrap</a> <a href="./format.html">format</a> <a href="./po.html">po</a> <a href="./wmd.html">wmd</a> </div> <div class="pagedate"> Last edited <span class="date">Tue Feb 26 23:01:54 2019</span> <!-- Created <span class="date">Tue Feb 26 23:01:54 2019</span> --> </div> </div> <!-- from ikiwiki --> </div> </div> </body> </html>
