Using fragment identifiers with Markdown docs

Sean Leonard
Fri, 24 Oct 2014 19:46:36 -0000

Hi Markdown folks:

I wanted to see if people have feelings or opinions about using fragment
identifiers with Markdown (and Markdown-derivative, such as pandoc,
kramdown, etc.) content.

It is useful to say things like

readme.md#how-to-install

So that a Markdown editor could scroll to the right content.

To my mind, the prime candidates for this treatment are the [link
reference identifiers][lref] and for some formats, the attributed text
{#blahblah }. Link reference identifiers are part of the original
Markdown syntax. On the other hand, they don't produce any identifiers
in HTML/XHTML. Clearly attributed text is useful to identify both
Markdown and output regions.

[lref]: http://daringfireball.net/projects/markdown/syntax#link

Thanks,

Sean