Markdown 目录生成器
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_15292d5a/yjkj-markdown-toc。
技能介绍
问题:长 Markdown 文档缺目录
当文档从十几行膨胀到几百行后,# 到 ###### 标题散落在正文中,读者很难快速定位章节,作者也要手工整理目录并反复维护。若文档里有重复标题、行内格式或代码块示例,简单正则很容易误判,也可能生成不可点的锚点。
工作方式:按标题生成可插入 TOC
markdown-toc 从 Markdown 文件中提取标题,并生成适合插回正文的目录。核心能力包括:
- 识别
#到######的 1-6 级标题; - 支持 bullet list 与 linked 两种目录格式;
- 可按标题级别过滤,输出更紧凑的结构;
- 为重复标题生成唯一锚点,避免链接失效;
- 保留标题中的粗体、斜体、行内代码等格式;
- 跳过代码块内看似标题的文本,降低误提取概率。
适用边界
它面向已有标准 Markdown 标题的文档生成目录,不负责重排文档结构,也不会自动修复非标准标题。若标题层级混乱或章节命名不规范,目录可读性仍受原文限制。
使用场景
- 给超过百行的 API 设计文档生成 1-3 级标题目录,方便评审快速定位接口章节。
- 为带重复小标题的运维手册生成链接式 TOC,并让重复锚点不互相覆盖。
- 整理技术博客时过滤掉四级以下标题,只保留主章节形成简洁列表目录。
- 把教程中粗体、斜体和行内代码标题保留进目录,避免目录文本失真。
适合人员
- 维护内部 Wiki 的工程文档负责人,需要把长页面整理出可点击目录。
- 写技术博客的作者,想在 Markdown 初稿中快速插入层级目录。
- 做 API 手册的开发者,希望按章节生成链接目录便于评审。
- 管理运维手册的团队,需要处理重复标题并生成稳定锚点。