Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

@davidchambers
Copy link

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}
@bkeepers
Copy link
Contributor

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 bkeepers closed this as completed Mar 4, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants