]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/bugs/Commonmark_support.mdwn
initial patch for CommonMark support
[git.ikiwiki.info.git] / doc / bugs / Commonmark_support.mdwn
index 5ee014b195167693a537795a34f5c7e659481a3e..cd1bd90f854a9a10a8eb551fafb42e7aa118f263 100644 (file)
@@ -1,3 +1,29 @@
 I suffer from the occasional markdown glitches using branchable.
 
 I've found that switching my own non-ikiwiki projects to https://github.com/jgm/CommonMark has helped sort them out for the most part.
+
+> ikiwiki does not implement Markdown on its own: it uses one of several
+> third-party libraries, with the current recommendation being
+> Discount. Out-of-process implementations like
+> [[plugins/contrib/pandoc]] are not suitable to be the default for
+> performance reasons.
+>
+> There seems to be a Perl binding for libcmark at
+> <https://github.com/nwellnhof/perl-commonmark>, but unfortunately
+> its README points out that the libcmark API is not stable,
+> which means libcmark and perl-commonmark would have to be upgraded
+> in lockstep: this makes them awkward to deal with in Linux
+> distributions. As a result I'm not going to look into this myself
+> until there is a stable API for Commonmark available in Debian.
+>
+> However, if you want to add optional Commonmark support to the
+> [[plugins/mdwn]] plugin, I'd review a patch. --[[smcv]]
+
+----
+
+A very initial patch is here. There might be ikiwiki-to-commonmark option translation
+to do.
+
+Patch: <https://github.com/jmtd/ikiwiki/commit/c76eeac8152604ce3d7d1672fe404c8ee8ef2dd8>
+[[!tag patch]]
+[[!template id=gitbranch branch=jon/commonmark author="[[Jon]]"]]