发布于 2026 年 3 月

Markdown 自动生成目录

长篇 Markdown 文件需要导航。从标题生成的目录让任何文档都变得可以快速浏览。ShowMeMyMD 自动生成目录 — 无需标签,无需插件,无需 CLI 工具。


## 问题

Markdown 没有内置目录

Markdown 没有目录语法。规范中没有 [TOC] 标签。有些工具支持,大多数不支持。

所以人们用各种方式变通。CLI 生成器如 markdown-toc doctoc 将目录 Markdown 注入到你的文件中。VS Code 有相关扩展。GitHub 在网页端为 README 文件自动生成目录。

但这些都不是自动的。你要么修改文件,要么安装工具。而且当你改变标题后,目录就过时了,直到你重新运行什么东西。


## ShowMeMyMD 的方式

打开文件,目录已经在那了。

ShowMeMyMD 打开任何包含标题( # ######)的 .md 文件,它会自动生成可点击的目录。

无需插入标签。无需安装插件。无需运行 CLI 工具。无需配置。打开文件就能导航。

关键细节

目录在渲染时生成。你的 .md 文件永远不会被修改。改了标题?下次打开文件时目录就会即时更新。


## 为什么重要

长文档需要导航

任何有结构的文档都能从可点击的目录中受益。跳转到你需要的章节,而不是在数百行中翻滚。

README 文件

包含安装、使用方法、API 文档和贡献指南的开源项目。直接跳转到需要的内容。

文档

技术规格、API 参考、运维手册。目录将一面文字墙变成可导航的资源。

会议记录

议程项目、决定、行动项。无需重读整份文档就能找到上周的决定。

技术规格

架构决策、设计文档、RFC。按章节导航复杂文档。


## 替代方案

获取 Markdown 目录的其他方式

手动目录

手动编写指向标题锚点的 Markdown 链接,比如 [安装](#installation)。写起来麻烦,标题改了就会断裂,需要自己维护。

markdown-toc (npm)

CLI 工具,生成目录并作为 Markdown 文本插入到你的文件中。能用,但需要 Node.js、npm 安装,而且每次标题变动都要重新运行。会修改源文件。

VS Code 扩展

多个 VS Code 扩展可以生成目录。在 VS Code 中工作,但你需要打开 VS Code — 一个完整的 IDE 只为导航一个文档。

GitHub

GitHub 在网页端自动为 README 文件生成目录。点击文件名旁边的汉堡图标。但这只在 GitHub.com 上有效 — 不适用于你 Mac 上的本地文件。


## 简单方式

直接打开文件

ShowMeMyMD 从标题自动生成目录。不修改你的文件。非破坏性。支持从 # ###### 的任何标题结构。

目录始终是最新的,因为它是从文件当前的状态生成的 — 而不是从缓存快照或可能过时的注入块。


## 继续阅读


别再翻滚了。开始导航。

$2.99,一次购买,无需订阅,无需账号。

下载于Mac App Store