How to link to headings in GitHub issues and pull requests

README.md

How to link to headings in GitHub issues and pull requests

If you have an issue comment / PR description on GitHub, it doesn't automatically get anchors / IDs that you could link to:

What I like to do is to add a visible # character like this:

It renders like this:

Copy/paste-friendly Markdown snippet:

# Some heading <a href="#user-content-some-heading" id="some-heading">#</a>

Don't forget to add the user-content- prefix to href – that's how GitHub transforms custom IDs.

---

Alternatively, if you don't want the visible # character, you could also do this:

It renders like this:

The same URL as before can be used to link to this heading, e.g.:

https://github.com/borekb/example/issues/123#user-content-second-section

(You can use browser dev tools' Inspect element to find out the anchor.)

For future reference, the # text doesn't need to be there.

- [A title](#a-title)

## A title <a href="#a-title" id="a-title"/>

Worked for me.

Kudos!

This is the best thing I've ever come across! Thanks, all! 🚀

Thank you!