Search code examples
githubsystemjsgithub-flavored-markdownreadme

GitHub SystemJS README.md table of contents

I've been writing some README markdown lately, and I wanted to know how the heck some open source projects README.md files render with an automatic table of contents? If you look at SystemJS for example, their README.md file loads with a TOC however their markdown source doesn't include that table of contents.

https://github.com/systemjs/systemjs

It has to come from somewhere... See the screenshot below:

enter image description here

Solution

  • I still don't see the table of contents in your screenshot. It looks like you might have installed this Github Toc Chrome extension?

    Allows to show you a "table of content" generated by Github project README or WIKI.

    The formatting of the two screenshots is very similar, including the somewhat unusual treatment of nested lists with blue dashes.

    If this is the case, then the TOC is being generated by JavaScript in the extension.