some notes on ikiwiki vs. Markdown

2 files changed, 28 insertions, 0 deletions

diff --git a/doc/todo/Fenced_code_blocks___40__from_GitHub_Flavored_Markdown__41__.mdwn b/doc/todo/Fenced_code_blocks___40__from_GitHub_Flavored_Markdown__41__.mdwn
index bf1ca0eb4..819f1ac25 100644
--- a/doc/todo/Fenced_code_blocks___40__from_GitHub_Flavored_Markdown__41__.mdwn
+++ b/doc/todo/Fenced_code_blocks___40__from_GitHub_Flavored_Markdown__41__.mdwn
@@ -43,4 +43,22 @@ main = forever $
 > >
 > > ... maybe a bug in Discount... --[[anarcat]]
 
+> > > Discount versions older than 2.1.6 do not support the \`\`\` fences.
+> > > ikiwiki.info (hosted by branchable.com) presumably runs on Debian
+> > > stable, which only has 2.1.3. I am not involved in running Branchable,
+> > > but it seems reasonable to assume that it will be upgraded to 2.1.7
+> > > as part of upgrading to Debian 8 when that is released. --[[smcv]]
+
 > > I strongly support this feature as well! --[[integrii]]
+
+> > > ikiwiki has no support for specific Markdown features: all it does
+> > > is to recognise a Markdown file and give it to a Markdown
+> > > implementation such as [[!cpan Text::Markdown::Discount]].
+> > > If you would like ikiwiki to support a different subset of Markdown,
+> > > please either recommend a better Markdown implementation, or
+> > > report bugs / feature requests to the maintainer of Discount.
+> > >
+> > > In this case it appears there is no code change required in
+> > > ikiwiki (and for that matter, nothing to do in Discount either
+> > > because the feature request has already been implemented),
+> > > so I'm [[closing this todo item|done]]. --[[smcv]]
diff --git a/doc/todo/Track_Markdown_Standardisation_Efforts.mdwn b/doc/todo/Track_Markdown_Standardisation_Efforts.mdwn
index 54a615920..85dfddf26 100644
--- a/doc/todo/Track_Markdown_Standardisation_Efforts.mdwn
+++ b/doc/todo/Track_Markdown_Standardisation_Efforts.mdwn
@@ -5,3 +5,13 @@ Just a quick note that some people are making noise about Markdown standardisati
   * <http://johnmacfarlane.net/babelmark2/faq.html#what-are-some-big-questions-that-the-markdown-spec-does-not-answer>
 
 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]]