Markdown 目錄產生器

根據文件標題產生帶連結的 Markdown 目錄。可選擇標題層級和清單樣式,使用相容 GitHub 的錨點,全部在本機處理。

專案筆記

概覽

安裝

範例

使用

範例

文件處理在瀏覽器中完成,無需註冊或上傳檔案。

標題連結與 Markdown 相容性

目錄是指向文件標題的巢狀連結清單。GitHub 風格的錨點保留 Unicode 字母、移除標點符號,並為重複標題加上數字後綴。程式碼區塊不會被辨識為標題。篩選標題層級時,原始錨點和文件順序保持不變。

不同 Markdown 應用程式的錨點規則可能不同。這裡產生的是 GitHub 風格的自動標題 ID,自訂 HTML ID 或其他渲染器的規則可能不相容。預覽中的連結指向下方文件。修改標題後,需要重新產生目錄。

可以自行驗證的範例

選擇標題層級 2–6。H1 不列入目錄,但仍佔用 #setup,因此兩個 H2 連結分別為 #setup-1 與 #setup-2。程式碼圍欄內的標題不列入目錄;這些細節會影響實際 README 的跳轉。

Markdown 來源文件
# Setup

## Setup

### Examples

## Setup

```md
## Hidden
```
Markdown 輸出
- [Setup](#setup-1)
  - [Examples](#examples)
- [Setup](#setup-2)

結果不符時如何排查

連結跳轉錯誤時,比對目標平台的標題 ID 與產生的錨點。自訂 ID 或另一處同名標題都可能改變目標。重新命名或移動標題後重新產生,並確認所選層級確實存在於文件中。