This page uses BitDownToc to insert Table of Contents (TOC) in your markdown.
paste markdown here
view markdown with TOC here
BitDownToc comes with pre-defined profiles. The important options for each are:
Generic → generate anchors (.e.g BitBucket Server
GitLab → concat spaces, do not generate anchors
GitHub → do not concat spaces, do not generate anchors
dev.to → concat spaces, do not generate anchors, use
liquid tags for comments
(hashnode) → concat spaces, do not generate anchors, anchors prefix
set to "heading-"
If your markdown renderer is not on the list, turn on generate anchors
(Generic profile) to generate HTML elements such as <a name="..."> at the top
of each heading to support navigation. This trick works anywhere, as long as HTML is supported.
Use the [TOC] marker to control where the TOC will appear.
Any header(s) above it won't be part of it.
BitDownToc adds comments by default, so you can update the TOC anytime with this tool.
BitDownToc is free and open-source.
It also works in the terminal! To find out more, visit the project repository.