+
×
+
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
+ - GitLab 17 โ do not 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 "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.
+
+
+ โ https://github.com/derlin/bitdowntoc โ
+
+
+ The web version uses the open-source tracker
+ posthog to get insights about usage.
+ The text you enter and your IP are excluded from tracking.
+