工作原理
Markdown 目录生成器通过解析您的 Markdown 源代码,提取所有的标题(Header)标记(如 #, ## 等)。
1. 解析标题
工具使用词法分析器扫描文本,忽略代码块内的 # 符号,准确识别文档结构。
2. 生成锚点 (Slug)
根据 GitHub Flavored Markdown (GFM) 标准生成锚点链接。例如,标题 "Hello World!"
会被转换为 #hello-world。
3. 构建树状结构
根据标题的层级(H1-H6),自动生成缩进列表,形成清晰的目录结构。
使用场景
GitHub README
为您的开源项目 README.md 文件生成专业的导航目录,帮助用户快速定位文档内容。
技术博客写作
在 Hugo, Hexo 或 Jekyll 博客中直接插入生成的 TOC,提升长篇文章的阅读体验。
API 文档
整理复杂的 API 接口文档,生成清晰的接口列表索引,方便开发者查阅。
常见问题
支持 GitHub 风格的锚点吗?
支持。工具默认采用 GFM (GitHub Flavored Markdown) 算法生成锚点:转换为小写,去除非字母数字字符,并将空格替换为连字符。
如何忽略代码块中的标题?
本工具使用专业的 Markdown 解析器(Marked.js),能够智能识别并忽略代码块(Code Blocks)内部的 # 符号,防止将其误判为标题。
能否生成带有数字序号的目录?
可以。在上方的“列表符号”设置中选择 “1. (有序)”,生成的目录将使用数字列表格式(1. 1.1 1.2 ...)。
支持中文标题锚点吗?
支持。中文标题通常会被直接保留作为锚点(例如:#中文标题),这符合大多数现代 Markdown 渲染引擎(如 GitHub, VS Code)的标准。
可以将目录直接插入到 Markdown 文件中吗?
是的,您只需复制生成的 TOC 代码块,粘贴到 Markdown 文件的任意位置(通常是顶部)即可。
所有 Markdown 编辑器都支持 TOC 吗?
并非所有编辑器都原生支持 `[TOC]` 语法,但本工具生成的“列表式 TOC”是纯 Markdown 代码,兼容几乎所有 Markdown 预览器和编辑器。
如何处理重复的标题?
GitHub 标准会在重复标题的锚点后添加后缀(如 -1, -2)。本工具目前生成的锚点遵循简单规则,如有重复标题,建议手动区分以避免跳转错误。
数据会上传到服务器吗?
绝对不会。所有 Markdown 解析和 TOC 生成过程都在您的浏览器本地完成(Client-side only),您的文档内容非常安全。