Skip to content

Instantly share code, notes, and snippets.

Avatar

Rachel Hyman rachelhyman

View GitHub Profile
@rachelhyman
rachelhyman / gist:b1f109155c9dafffe618
Last active Sep 20, 2022
Github README anchor links
View gist:b1f109155c9dafffe618

To create anchor links that jump down to different sections of a README (as in an interactive table of contents), first create a heading:
#Real Cool Heading

The anchor link for that heading is the lowercase heading name with dashes where there are spaces. You can always get the anchor name by visiting the README on Github.com and clicking on the anchor that appears when you hover to the left of the heading. Copy everything starting at the #:
#real-cool-heading

Wherever you want to link to your Real Cool Heading section, put your desired text in brackets, followed by the anchor link in parentheses:
[Go to Real Cool Heading section](#real-cool-heading)