aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
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.