aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorsmcv <smcv@web>2017-05-14 07:47:42 -0400
committeradmin <admin@branchable.com>2017-05-14 07:47:42 -0400
commitb14e3456ddab67cde270080e01c473fc96dac5be (patch)
tree9602c7ccac81edf4fc3636b03e7dc5842c2908c5 /doc
parent50fb6f8b9558cac2a3d2266fd9b5a705c22ef0f7 (diff)
downloadikiwiki-b14e3456ddab67cde270080e01c473fc96dac5be.tar
ikiwiki-b14e3456ddab67cde270080e01c473fc96dac5be.tar.gz
multimarkdown: it's a trap!
Diffstat (limited to 'doc')
-rw-r--r--doc/todo/toc-with-human-readable-anchors.mdwn8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/todo/toc-with-human-readable-anchors.mdwn b/doc/todo/toc-with-human-readable-anchors.mdwn
index 60edaffcb..09985a9e4 100644
--- a/doc/todo/toc-with-human-readable-anchors.mdwn
+++ b/doc/todo/toc-with-human-readable-anchors.mdwn
@@ -31,6 +31,14 @@ doing this:
add `id` anchors when using [Text::Multimarkdown][] which is
simply a matter of adding `multimarkdown: 1` in the setup file
+ > I don't think multimarkdown is a good solution. It served a useful
+ > purpose when we were defaulting to [[!cpan Text::Markdown]] or to
+ > `markdown.pl`, but now that we're using Discount by default,
+ > Multimarkdown is mostly a trap for the unwary - it's a less predictable
+ > and (in general) less featureful parser than Discount. Ideally we'd
+ > always be using CommonMark or Discount these days, but as
+ > far as I know there's still no API-stable CommonMark library. --[[smcv]]
+
2. enable the [[plugins/headinganchors]] plugin. if multimarkdown is
disabled, this can also provide usable identifiers.