]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/todo/Track_Markdown_Standardisation_Efforts.mdwn
discount markdown can't handle URIs with parens e.g. mediawiki style
[git.ikiwiki.info.git] / doc / todo / Track_Markdown_Standardisation_Efforts.mdwn
index 54a615920f40ffe6e628d676c37d8f6c9fb6a748..90aba7a253b918d8a4188ec79048261e67d0aebc 100644 (file)
@@ -3,5 +3,35 @@ Just a quick note that some people are making noise about Markdown standardisati
   * <http://markdown.github.com/>
   * <http://www.codinghorror.com/blog/2012/10/the-future-of-markdown.html>
   * <http://johnmacfarlane.net/babelmark2/faq.html#what-are-some-big-questions-that-the-markdown-spec-does-not-answer>
+  * <http://commonmark.org/>
 
 It might be worth following...
+
+> ikiwiki does not implement Markdown: we use a third-party library for that
+> (there are several options, but the recommended one is currently
+> [[!cpan Text::Markdown::Discount]]). We support whatever dialect
+> of Markdown is implemented by the chosen Markdown implementation.
+>
+> As a result, nothing is likely to change in ikiwiki's interpretation of
+> Markdown unless someone either changes the behaviour of Discount,
+> or recommends a different (and hopefully better) third-party library.
+> --[[smcv]]
+
+> I am not sure the noise is so much "recent" anymore: that article
+> announcing Commonmark is from 2012 and markdown.github.com is from
+> around 2014. Presumably, Commonmark will become official in 2016,
+> but you know what they say about [standards][]...
+>
+> I guess the only thing that Ikiwiki would need to do would be to
+> somewhat support Commonmark. There's a [Perl library][] that wraps
+> the C library, but nothing native yet.
+>
+> I guess we would need to test how it performs and compares with 
+> Discount, but having it as a third party module is up for anyone's
+> grab. It should be a fairly simple implementation after all...
+> Then it should probably be mentionned in [this discussion][] for 
+> everyone's benefit as well. --[[anarcat]]
+[standards]: https://xkcd.com/927/
+[Perl library]: https://metacpan.org/release/CommonMark
+[this discussion]: https://talk.commonmark.org/t/i-wonder-if-there-is-a-wiki-engine-that-uses-markdown/1281/18