Create a gist now

Instantly share code, notes, and snippets.

What would you like to do?
Github Markdown Heading Anchors

Anchors in Markdown

To create an anchor to a heading in github flavored markdown. Add - characters between each word in the heading and wrap the value in parens (#some-markdown-heading) so your link should look like so:

[create an anchor](#anchors-in-markdown)

LukeLR commented Jun 23, 2015

Thanks! Helped me a lot!

vso-tc commented Jul 10, 2015

Awesome. Thank you!

JBarna commented Aug 5, 2015

Thank you.

My headings are not generating anchor tags so can't create hyperlinks to point to it. Any solution?

Have you written the anchor name in lowercase? (like [create an anchor](#anchors-in-markdown) instead of [create an anchor](#Anchors-in-markdown))
That's what happened to me.. only worked when i changed all to lowercase.

Works great. Thanks for the tip 👍

idkw commented Sep 30, 2015

It doesn't seem to work, it just displays (#some-markdown-heading)

Same result here, it's not interpreting that specially.

The code that creates the anchors is here:
https://github.com/jch/html-pipeline/blob/master/lib/html/pipeline/toc_filter.rb

  1. It downcases the string
  2. remove anything that is not a letter, number, space or hyphen (see the source for how Unicode is handled)
  3. changes any space to a hyphen.
  4. If that is not unique, add "-1", "-2", "-3",... to make it unique

tomfun commented Nov 16, 2015

I was interested of autodocumentation
in my case I use this code (for git lab)

//... val is input
  var anchor = val.trim().toLowerCase().replace(/[^\w\- ]+/g, ' ').replace(/\s+/g, '-').replace(/\-+$/, '');
  if (usedHeaders.indexOf(anchor) !== -1) {
    var i = 1;
    while (usedHeaders.indexOf(anchor + '-' + i) !== -1 && i++<=10);
    anchor = anchor + '-' + i;
  }
  usedHeaders.push(anchor);
  console.log(val, anchor)//result her!
  return '  '.repeat(level) + '* [' + val + '](#' + anchor + ')\n';

Thanks mate! 👍

Aliance commented Mar 11, 2016

👍

marsalv commented Apr 19, 2016

Thanks! 👍

This tip does not work with an anchor containing non-ascii characters, e.g., an English+CJK string like this:

[English中文标题](#English中文标题)

won't lead you to:

English中文标题

I tried adding a white space between the English and the first CJK character in the title, then added a dash in-between. This doesn't create the right link either.

@kakyoism the correct link is [English中文标题](#english中文标题)
(note the lowercase "e" as explained above)

It will link to:

# English中文标题

svmotha commented Jun 12, 2016 edited

How can I use punctuation in my anchors? I tried using the backslash before the punctuation mark in my case a comma. See below example:

[Ready, set, GO!](#ready\,-set\,-go) 

This didn't work though. Am I doing it wrong, or is it not even possible?

svmotha commented Jun 12, 2016

It's okay, I fixed it. I realized that the anchor can work fine without the inclusion of the punctuation. See example below

[Ready, set, GO!](#ready-set-go)

will result in an anchor that works just fine.

This is weird. I have the anchor like ## check out / check in files and the link like [link](#check-in-check-out-files) that doesn't work. From the ruby code I think it should handle it but it doesn't. Why?

ljvasey commented Nov 28, 2016 edited

Here's a tip -- if you're having trouble with your anchor not working due to misspellings or odd characters, simply hover over your heading on Github, then hover or click the link icon that appears to the left. You can then right click to copy the link location, left click it to go to the URL and view it in your address bar, or simply stay hovered over it and view it in the status bar of your browser.

@sandyleo26, your example has check out / check in reversed from the anchor to the link. @svmotha's tip fixed my issue of anchors with special characters.

pxlshpr commented Feb 17, 2017 edited

@tomfun the correct regex substitutions for the first line would be:

var anchor = val.trim().toLowerCase().replace(/[^\w\- ]+/g, '').replace(/\s/g, '-').replace(/\-+$/, '');

It's important that every space in the title be converted to a - for the anchor to work – but using \s+ instead of \s prevents this.

How would I get anchors working on github pages?

Thanks!

zyxan commented Mar 27, 2017

is this still working? can't manage to get it work on my PR, it successfully creates the link but inspecting the DOM headers don't appear to have anchors.

duhaime commented Apr 19, 2017 edited

@zyxan This technique works, though the gist could be a little more explicit.

To create an anchor tag in github markup, you just need to create a heading element. Example:

#### Installation guide
Here would be some installation instructions

When GitHub transforms this markdown into html, the #### Installation guide line above will be represented as:

<a href='#installation-guide' id='installation-guide' class='anchor' aria-hidden='true'>Installation guide</a>

You can link to this href with a link that looks like this:

[Read our installation guide](#installation-guide)

I hope that helps!

eeholmes commented May 4, 2017

Is there a way to specify the anchor name? As soon as I change my section name, all my links will break. I want to specify the anchor like normal for markdown but the html generated from my README.md file is not working as normal for markdown.

So my README.md has

# This is a section name that I might change {#foo}

Normally, this sort of link would work [link](#foo) but it is not working in the html autogenerated by Github from my README.md file.

thank you @eeholmes, such a GREAT ADVICE!

wayri commented Jun 18, 2017 edited

Take me where
I guess markdown behaves quite similar to html. I will attach an example below;

[Take me there](#there_you_go)
[Take me where](#here)

I defined two links with anchor names

below is the first anchor

<a name="there_you_go"></a>Take me there

here is the second anchor

<a name="here"></a>Take me where

here is it in practice

Take me there will take you down
Take me where will take you up
/
Take me there
/
blank space for test
/
/
/
/
/
/
blank space end
/
/

So it does work. Hope this helps

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