Table of Contents

GitHub will automatically generate a TOC based on the headings in your README.md file, you can see it by clicking the menu icon in the upper right-hand corner of the README:

However, it’s still good practice to have a TOC in the README itself for users who will be viewing it in other locations. You can do this easily by using Markdown’s internal link capabilities. See the example TOC in the README template in the companion GitHub repo for an example.