Markdown 目录生成器:粘贴 markdown, 自动生成带锚点链接的目录。
- 本地处理
- 分类 格式转换
- 适合 把粘贴内容或本地文件转成更适合交付的格式。
- [项目](#项目)
- [安装](#安装)
- [macOS](#macos)
- [Linux](#linux)
- [使用](#使用)
- [API](#api)
- [init()](#init)
- [run()](#run)
- [许可证](#许可证)这个工具能做什么
免费在线 Markdown 目录生成工具。把 README、规范文档或任何 .md 文件 贴进来,立刻得到一份干净的嵌套 `- [标题](#锚点)` 列表,可以直接放进 GitHub、GitLab、Bitbucket 或任意 CommonMark 渲染器。可选标题深度 (H1–H6, 或 README 常用的 H2–H4)、开/关层级编号 (1. / 1.1 / 1.1.1)、 2 或 4 空格缩进,以及锚点风格 (GitHub / GitLab / Bitbucket / CommonMark)。 每种风格的 slug 规则我们都按各家原样实现,链接复制过去就能点开,不会 因为大小写或符号不同而 404。还有一键"复制完整文档":自动把 TOC 拼回 原文,有 `<!-- TOC -->` 占位符就替换,没有就插在第一个 H1 之后。 围栏代码块里的 `#` 自动跳过,重复标题按 GitHub 风格自动加 `-1` `-2` 后缀。 100% 浏览器本地处理,文档不上传。
工具细节
- 输入
- 文本 + 数值 + 结构化内容
- 页面会根据工具类型展示文本框、数值控件、文件选择或结构化输入。
- 输出
- 即时结果 + 复制
- 结果区优先给出可操作结果，支持项会显示复制、下载或可视化预览。
- 隐私
- 浏览器本地处理
- 主工具逻辑未发现外部 API 调用，输入通常留在当前标签页内处理。
- 保存 / 分享
- 免账号使用
- 打开页面即可使用；刷新后是否保留结果取决于具体工具。
- 性能预算
- 首屏 JS ≤ 14 KB
- 没有声明 WASM 依赖，适合快速打开和移动端使用。
- 适用场景
- 格式转换 · 程序员
- 分类和职业标签用于推荐相关工具、组织内链，并帮助用户快速判断是否适合当前任务。
怎么用
-
1. 输入
把内容粘贴或拖入工具面板。
-
2. 处理
点击按钮,在浏览器内本地处理,文件不上传。
-
3. 复制 / 下载
一键复制结果或下载到本地。
Markdown 目录生成器 适合怎么用
适合把内容从一种实际格式转成另一种可用格式。
适合转换的任务
- 把粘贴内容或本地文件转成更适合交付的格式。
- 放进大流程前,先预览转换结果是否可靠。
- 修正常见格式不匹配,不用打开完整编辑器。
转换检查项
- 源格式比较乱时,先拿一小段试转。
- 转换后检查编码、分隔符和换行符。
- 结果确认前保留原始内容。
下一步可以接着做
这些入口会把当前任务接到更完整的工具链里。
真实使用场景
让 4000 行的 README 在 GitHub 上还能找得到路
开源项目的 README 涨到 38 个 H2/H3 小节,读者翻半天才找到安装步骤。 把整个文件贴进来,选 H2-H3、GitHub 风格,生成的列表放进 `<!-- TOC -->` 标记下面。下次加了新章节,重新生成再点「复制完整文档」,只会改写两个 标记之间那段,正文一个字节都不动。
文档搬到 GitLab 后锚点 404 的修法
你把 12 篇 markdown 指南从 GitHub 搬到 GitLab wiki,结果一半页内链接 失效,因为 GitLab 保留下划线而 GitHub 会去掉。把锚点风格切到 GitLab, 每篇重新生成一遍,`#my_section` 这种锚点就又能跳转了,两百多个标题不用 你一个个去猜 slug。
给 60 页规范文档加上可引用的编号大纲
要过法务评审的产品规范需要稳定的章节号,大家好在评论里引用(「见 3.2.1」)。 打开层级编号,深度设 H1-H4,TOC 就输出 1.、1.1、1.1.1,计数器按父级 自动归零。锚点本身不变,原来的深链接照样能点,评审同事也拿到了想要的编号。
跳过藏在代码示例里的伪标题
教程里贴了 shell 会话,`# 构建镜像` 这种注释行看起来跟 H1 标题一模一样。 换成笨办法的正则 TOC 会把它们当成真章节列出来。这里会追踪围栏代码块 (``` 和 ~~~)并跳过,大纲只显示你真正的 9 个小节,而不是混进代码里的 15 行注释。
常见踩坑
README 选 H1-H6 会把每个小标题全塞进目录。普通 readme 用 H2-H3 既有大节又不啰嗦,H1-H6 留给长规范文档。
生成 GitHub 风格的 TOC 直接贴到 Bitbucket,链接会无声失效,因为 Bitbucket 要带 `markdown-header-` 前缀。复制前先把锚点风格切到对应平台。
文件里没放 `<!-- TOC -->` 标记就点「复制完整文档」,TOC 会落在第一个 H1 之后而不是你想要的位置。先加上这对标记,既能控制插入点又能干净地反复重生成。
隐私说明
全程在你的浏览器里跑。你的 markdown 在本地解析生成 TOC,不会离开页面,也 不会发到任何服务器。文档正文也不写进 URL,所以贴内部规范、未发布的 README 或私人笔记都安全,不会被上传或外泄。只有你选的参数(深度、缩进、锚点风格) 会进 URL,方便分享链接。
常见问题
类似工具组合
做你这行的人, 还会一起用这些。