Markdown 工具

Markdown 目录生成器

从Markdown标题自动生成目录(TOC)。支持链接、嵌套级别、自定义深度和slug生成。

markdowntoctable of contentsgenerator

Markdown Input

Table of Contents

What is Markdown 目录生成器?

Markdown目录生成器扫描Markdown文档,并根据标题层次结构(h1到h6)自动构建嵌套的超链接目录(TOC)。长篇技术文档、README文件、书籍、教程文章和API参考指南极大地受益于让读者直接导航到感兴趣部分的TOC。然而,随着标题的重命名、重新排序或删除,手动维护TOC链接容易出错且重复— 一个标题更改会破坏多个链接。本生成器解析标题结构,生成与GitHub/GitLab兼容的锚点slug(小写、空格转破折号、剥离特殊字符),生成反映标题深度的正确缩进嵌套项目符号列表,支持可配置的最大TOC深度以防止过度深度的嵌套链接,并可以在重复标题slug冲突时可选地添加唯一数字后缀(就像GitHub所做的那样)。可选地将TOC包装在<details><summary>可折叠HTML标签中,以便嵌入到长Markdown文件的顶部而不会占用过多垂直空间。任何时候文档更改都可以单击重新生成TOC。

When to Use Markdown 目录生成器

用于编写长篇技术文档、维护包含多个部分的README文件、创建教程或课程大纲、组织API参考文档,或构建基于Markdown的书籍。

How to Use Markdown 目录生成器

粘贴完整的Markdown文档。配置TOC深度(推荐h2-h4)。切换有序vs无序列表、包装在details标签和重复后缀处理。复制生成的TOC粘贴到文档顶部。