發布於 2026 年 3 月

Markdown 的自動目錄生成

長篇 Markdown 檔案需要導覽。從標題生成的目錄讓任何文件都能快速瀏覽。ShowMeMyMD 自動生成目錄 — 不需要標籤、不需要外掛、不需要 CLI 工具。


## 問題

Markdown 沒有內建的目錄

Markdown 沒有目錄語法。規格中沒有 [TOC] 標籤。有些工具支援,大多數不支援。

所以人們想辦法繞過。像 markdown-toc doctoc 這樣的 CLI 工具會將目錄 Markdown 注入到你的檔案中。VS Code 有相關的擴充套件。GitHub 會在網頁上為 README 檔案自動生成目錄。

但這些都不是自動的。你要嘛修改你的檔案,要嘛安裝工具。而且當你修改標題時,目錄就會過時,直到你重新執行某些指令。


## ShowMeMyMD 的處理方式

開啟檔案。目錄已經在那裡了。

開啟任何含有標題的 .md 檔案 — 從 # ###### ShowMeMyMD 就會自動生成可點擊的目錄。

不需要插入標籤。不需要安裝外掛。不需要執行 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