Markdown 目录生成器(表格式目录)

工作原理

适用于在长篇 README、技术博客文章或 Markdown 文档的开头自动添加可点击的目录:粘贴完整文档,点击「生成目录」,然后将得到的项目符号列表复制到文件顶部。每个条目都指向与标题对应的 `#标题短链` 锚点,可直接在 GitHub、GitLab 及大多数 Markdown 渲染引擎上使用。

标题是如何被检测到的?

该工具逐行查找以一个或多个 `#` 加空格开头的行(标准 ATX 风格:`# 标题`、`## 副标题`等)。另一种用下一行 `===` 或 `---` 下划线标记标题的 Markdown 风格不被识别;如果您使用这种风格,请先将标题转换为 `#` 记法。

链接的锚点是如何生成的?

每个标题都会被「slug 化」:转为小写、去除标点符号、并将空格替换为连字符。例如,「步骤 1:安装!」会变成锚点 `步骤-1-安装`。如果两个相同的标题生成了同样的锚点,大多数 Markdown 引擎会在第二个上自动添加数字后缀(`-1`、`-2`……)——如果您的文档包含重复标题,请检查最终渲染效果。

目录生成过程通过 WebAssembly 100% 在您的浏览器本地执行:您文档的内容永远不会离开您的设备。