Markdown TOC Generator

Markdown TOC Generator | Online Free Tool | Elysia Tools

Tool usage guide

Learn when to use this tool, what it supports, and how real users apply it.

Key facts

Category: Format Conversion
Input types: textarea, select, checkbox
Output type: text
Sample coverage: 4
API ready: Yes

Overview

The Markdown TOC Generator automatically creates a structured table of contents from your Markdown headings. It generates GitHub-style anchor links, allowing readers to navigate long documents, READMEs, or wiki pages with ease.

When to use

When writing long-form documentation or README files that need a clear navigation structure.
When you want to automatically generate GitHub-compatible anchor links for your Markdown headings.
When formatting wiki pages or technical blogs where readers benefit from a quick overview of the content outline.

How it works

1Paste your raw Markdown text into the input area.
2Configure your preferences, such as the minimum and maximum heading levels (H1 to H6), list style, and indentation.
3Choose whether to include anchor links and select your desired output format (Markdown, HTML, or both).
4Copy the generated table of contents directly into your document.

Use cases

Generating a table of contents for a project README.md file on GitHub.
Creating structured navigation outlines for technical documentation and user guides.
Formatting blog posts written in Markdown to improve readability and SEO structure.

Examples

1. GitHub README Navigation

Open Source Developer

Background

A developer is publishing a new open-source library and has written a comprehensive README.md file with multiple sections.

Problem

The README is very long, making it difficult for users to find installation instructions and API references quickly.

How to use

Paste the README content into the input, set the minimum heading level to H2, select 'Unordered' list style, and enable 'Include Anchor Links'.

minLevel: 2, maxLevel: 6, listStyle: unordered, indent: 2spaces, includeAnchor: true, outputFormat: markdown

Outcome

A clean, clickable Markdown list of H2-H6 headings with GitHub-compatible anchor links ready to paste at the top of the README.

2. Technical Documentation Outline

Technical Writer

Background

A technical writer is drafting a software user manual in Markdown and needs an HTML-formatted table of contents for a web portal.

Problem

The manual needs a structured, nested HTML list of headings from H1 to H3 to embed directly into a web template.

How to use

FAQ

How does the generator create anchor links?

It formats heading text into GitHub-style slugs, converting characters to lowercase and replacing spaces with hyphens.

Can I limit the table of contents to specific heading levels?

Yes, you can set the minimum and maximum heading levels (from H1 to H6) to filter out minor subheadings.

What list styles are supported?

You can choose between unordered lists (using hyphens) and ordered lists (using numbers).

Does this tool support HTML output?

Yes, you can output the table of contents as Markdown, HTML, or a combination of both.

Can I indent the list items with tabs instead of spaces?

Yes, the tool supports indentation using 2 spaces, 4 spaces, or tab characters.

minLevel: 1, maxLevel: 3, listStyle: unordered, indent: 4spaces, includeAnchor: true, outputFormat: html

Run this tool

Inputs

Result

Examples that match this tool

Continue with connected tools and hubs

Inputs

Result

Learn when to use this tool, what it supports, and how real users apply it.

Key facts

Overview

When to use

How it works

Use cases

Examples

1. GitHub README Navigation

2. Technical Documentation Outline

FAQ

Markdown Samples

Markdown Viewer Samples

Markdown Slide Deck Samples

PDF Samples

Slug Generator

Markdown to Plain Text

Array Element Deleter

Barcode Generator

Markdown Export, OCR, and Document Conversion Tools

Markdown Writing and Publishing Tools

Barcode, QR Code, and Label Tools

Documentation Authoring, Extraction, and Publishing Tools