Link to Headers in Github READMEs
Anytime you add a header to a markdown file, Github attaches an href
with its downcased, punctuation-stripped name. 'JavaScript' receives a link to #javascript
, for instance.
Spaces become dashes, so 'Command Line' becomes #command-line
.
Leverage this by adding a table of contents to your README with links to the headers further down the document:
### Table of Contents
- [Cucumber](#cucumber)
This will link to a header containing 'Cucumber'.
h/t Josh Branchaud
Tweet