]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blob - doc/bugs/Commonmark_support.mdwn
initial patch for CommonMark support
[git.ikiwiki.info.git] / doc / bugs / Commonmark_support.mdwn
1 I suffer from the occasional markdown glitches using branchable.
3 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.
5 > ikiwiki does not implement Markdown on its own: it uses one of several
6 > third-party libraries, with the current recommendation being
7 > Discount. Out-of-process implementations like
8 > [[plugins/contrib/pandoc]] are not suitable to be the default for
9 > performance reasons.
10 >
11 > There seems to be a Perl binding for libcmark at
12 > <https://github.com/nwellnhof/perl-commonmark>, but unfortunately
13 > its README points out that the libcmark API is not stable,
14 > which means libcmark and perl-commonmark would have to be upgraded
15 > in lockstep: this makes them awkward to deal with in Linux
16 > distributions. As a result I'm not going to look into this myself
17 > until there is a stable API for Commonmark available in Debian.
18 >
19 > However, if you want to add optional Commonmark support to the
20 > [[plugins/mdwn]] plugin, I'd review a patch. --[[smcv]]
22 ----
24 A very initial patch is here. There might be ikiwiki-to-commonmark option translation
25 to do.
27 Patch: <https://github.com/jmtd/ikiwiki/commit/c76eeac8152604ce3d7d1672fe404c8ee8ef2dd8>
28 [[!tag patch]]
29 [[!template id=gitbranch branch=jon/commonmark author="[[Jon]]"]]