Markdown 目录生成器

从 Markdown 标题生成目录,支持 GitHub 风格锚点链接

关键信息

分类
转换与编码
输入类型
textarea, select, checkbox
输出类型
text
样本覆盖
4
支持 API
Yes

概览

Markdown 目录生成器是一款高效的在线工具,能够自动提取 Markdown 文本中的 H1 至 H6 标题,并快速生成带有 GitHub 风格锚点链接的目录(TOC)。它支持自定义标题层级、列表样式(无序或有序)、缩进方式以及输出格式(Markdown 或 HTML),帮助您轻松为长篇文档、技术博客或 GitHub Readme 文件构建清晰的导航结构。

适用场景

  • 编写长篇 Markdown 技术文档或博客,需要为读者提供清晰的目录导航时。
  • 准备 GitHub 项目的 README.md 文件,需要添加支持锚点跳转的目录时。
  • 需要将 Markdown 标题大纲快速转换为 HTML 格式的嵌套列表目录时。

工作原理

  • 将您的 Markdown 文本粘贴到输入框中。
  • 根据需求配置参数,如设置最小/最大标题层级、列表样式(无序/有序)、缩进样式以及是否包含锚点链接。
  • 选择输出格式(Markdown、HTML 或两者),工具将自动解析标题并即时生成对应的目录结构。

使用场景

开源项目文档整理:为 GitHub 仓库的 README.md 自动生成带锚点链接的目录,提升项目易读性。
技术博客大纲提取:在发布长篇技术文章前,快速提取 H2 和 H3 标题,生成无序列表目录插入文章开头。
电子书与教程排版:将多章节的 Markdown 教程内容整理出结构化的 HTML 目录,用于网页端侧边栏导航。

用户案例

1. 为 GitHub README 生成无序锚点目录

开源项目维护者
背景原因
维护者正在编写一个复杂的开源库文档,README 包含多个 H2 和 H3 标题,用户阅读时滚动极不方便。
解决问题
需要快速生成一个符合 GitHub 锚点规范的无序列表目录,且只需包含 H2 和 H3 标题。
如何使用
粘贴 README 全文,将“最小标题层级”设为 H2,“最大标题层级”设为 H3,列表样式保持“无序”,勾选“包含锚点链接”,点击生成。
示例配置
minLevel: "2", maxLevel: "3", listStyle: "unordered", includeAnchor: true, outputFormat: "markdown"
效果
获得一段格式完美的 Markdown 目录代码,复制到 README 开头后,用户点击即可直接跳转到对应章节。

2. 提取博客大纲为 HTML 侧边栏导航

前端开发人员
背景原因
正在开发个人博客网站,需要将 Markdown 格式的文章标题提取出来,生成 HTML 格式的目录以渲染在网页侧边栏。
解决问题
手动编写嵌套的 HTML 列表标签非常繁琐且容易出错。
如何使用
粘贴文章的 Markdown 源码,将“输出格式”设置为 HTML,缩进样式选择“4 Spaces”,点击生成。
示例配置
outputFormat: "html", indent: "4spaces", includeAnchor: true
效果
自动生成结构清晰的 HTML 嵌套列表代码,直接粘贴至博客模板的侧边栏组件中即可使用。

用 Samples 测试

markdown, barcode

相关专题

常见问题

生成的目录链接支持在 GitHub 上直接跳转吗?

支持。默认生成的锚点链接采用 GitHub 风格的命名规则,可以直接在 GitHub 渲染的 Markdown 页面中实现点击跳转。

我可以只生成特定层级的标题目录吗?

可以。您可以通过设置“最小标题层级”和“最大标题层级”来过滤不需要的标题,例如仅提取 H2 到 H4 的标题。

什么是“用代码块包裹”选项?

开启该选项后,生成的目录代码会被包裹在 Markdown 代码块中,方便您一键复制,而不会在预览中直接渲染。

该工具支持生成 HTML 格式的目录吗?

支持。您可以在“输出格式”中选择 HTML 或 Both(Markdown + HTML),以获取标准的 HTML 嵌套列表代码。

目录的缩进样式可以自定义吗?

可以。工具支持 2 个空格、4 个空格或 Tab 键作为缩进样式,以适应不同的 Markdown 编辑器排版规范。

API 文档

请求端点

POST /zh/api/tools/markdown-toc-generator

请求参数

参数名 类型 必填 描述
markdownInput textarea -
minLevel select -
maxLevel select -
listStyle select -
indent select -
includeAnchor checkbox -
outputFormat select -
wrapCodeBlock checkbox -

响应格式

{
  "result": "Processed text content",
  "error": "Error message (optional)",
  "message": "Notification message (optional)",
  "metadata": {
    "key": "value"
  }
}
文本: 文本

AI MCP 文档

将此工具添加到您的 MCP 服务器配置中:

{
  "mcpServers": {
    "elysiatools-markdown-toc-generator": {
      "name": "markdown-toc-generator",
      "description": "从 Markdown 标题生成目录,支持 GitHub 风格锚点链接",
      "baseUrl": "https://elysiatools.com/mcp/sse?toolId=markdown-toc-generator",
      "command": "",
      "args": [],
      "env": {},
      "isActive": true,
      "type": "sse"
    }
  }
}

你可以串联多个工具,比如:`https://elysiatools.com/mcp/sse?toolId=png-to-webp,jpg-to-webp,gif-to-webp`,最多20个。

如果遇见问题,请联系我们:[email protected]