Allow heading names in READMEs to be specified to produce elegant URL fragments #159

Closed
davidchambers opened this Issue Oct 6, 2012 · 1 comment

Comments

Projects
None yet
2 participants

It'd be great if there were a way to specify a heading's name, and for this value to be used in the href of the corresponding anchor. Take the following Markdown snippet, for example:

### foo.bar(baz, quux)

This heading is given the name "foobarbaz-quux", which makes an ugly URL fragment. It'd be cool if this worked:

<h3 name="bar">foo.bar(baz, quux)</h3>

Or even better, something like this (which certain flavours of Markdown support):

### foo.bar(baz, quux) {@name=bar}
Owner

bkeepers commented Mar 4, 2015

Thanks for the feature request. That would definitely be great. We are not currently adding any extensions to our markdown syntax, but we are following the CommonMark project. You might be interested in this conversation.

Either way, adding support for this can not be accomplished by a change to this library, so I'm going to close this issue.

bkeepers closed this Mar 4, 2015

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment