Markdown 目录生成器
为 Markdown 文档生成目录。粘贴 README 或文档页面,选择要包含的标题级别,即可生成嵌套列表,其中包含指向各标题锚点的链接,锚点 ID 按照 GitHub 的生成方式创建。代码块中的标题会被跳过,重复标题会获得带编号的锚点。
常见问题
锚点链接是如何创建的?
锚点 ID 按照 GitHub 的生成方式创建:标题文本会转换为小写,标点和符号会被移除,空格会变为连字符。Getting Started 会变为 #getting-started,C++ & Rust 会变为 #c--rust。
重复出现的标题会怎样处理?
和 GitHub 一样,第二个同名标题的锚点会添加 -1,第三个添加 -2,以此类推,确保每个链接都指向正确的部分。
能识别哪些标题?
以一个到六个 # 开头的 ATX 标题,以及下方用 = 或 - 标记的 setext 标题。围栏代码块、缩进代码和 YAML 前置内容中的标题会被忽略。
如何处理标题中的格式?
链接只保留文本,行内代码会移除反引号,强调标记和 HTML 标签会被移除,图片则会被删除。目录条目文本和锚点都根据这些纯文本生成。
会包含哪些标题级别?
默认包含第 2 级和第 3 级,因为第 1 级标题通常是文档标题。可将最低和最高级别设为 1 到 6。列表会根据找到的最高级别标题进行缩进。
可以生成编号列表或纯文本吗?
可以。选择编号列表即可生成 1.、2. 以及嵌套编号;关闭链接后只显示标题文本,例如用于打印大纲。