Question 1

How does the TOC generator work?

Accepted Answer

The tool scans your Markdown for heading lines (# through ######) and generates a nested list of links. Each link points to the heading's slug anchor, following the same convention used by GitHub and other Markdown renderers.

Question 2

What is max depth?

Accepted Answer

Max depth controls how deep the table of contents goes. For example, a max depth of 3 includes h1, h2, and h3 headings but ignores h4 through h6. The default is 3, which works well for most documents.

Question 3

Can I generate an ordered (numbered) TOC?

Accepted Answer

Yes. Toggle the Ordered List switch to generate a numbered table of contents using 1. markers instead of - bullet points.

Question 4

Will the generated TOC links actually work?

Accepted Answer

The links use the same slug format as GitHub (lowercase, spaces to hyphens, special characters removed). They work out of the box on GitHub, GitLab, and most Markdown renderers that auto-generate heading anchors.

Question 5

Is my document sent to a server?

Accepted Answer

No. The TOC is generated entirely in your browser using JavaScript. Your Markdown content never leaves your device.

TOC Generator

Frequently Asked Questions