跳至內容
Fumadocs

導覽

整理側邊欄頁面、連結至其他資源,並發布多個版本的文件。

概覽

Fumadocs UI 提供多種版面配置來呈現內容,您可以透過版面配置指定導覽設定。

版本管理

若讀者需要查閱舊版發行版本的文件,可以同時保留多個版本。您可以選擇讓各版本共用同一個網站,或分別部署:

方式適用情境
根類型僅部分文件需要版本管理,且各版本位於同一個網站
完整版本管理對整個網站進行版本管理,每個版本各自部署

根類型

為每個版本各建立一個資料夾,並在 meta.json 中將它們標記為同一類型的根資料夾:

meta.json
index.mdx
getting-started.mdx
legacy-api.mdx
meta.json
index.mdx
getting-started.mdx
{
  "title": "1.0.0",
  "root": "version"
}

側邊欄只會顯示目前開啟版本的內容,而文件版面配置會算繪一個下拉選單,讓您在各版本之間切換,選項以各版本的 title 作為標籤。 切換時會停留在相同位置:系統會導向另一個版本中的同一頁面;若該版本中沒有此頁面,則導向其索引頁:

頁面切換至 2.0.0
/docs/v1/getting-started/docs/v2/getting-started
/docs/v1/legacy-api/docs/v2,即索引頁

小提示

類型名稱 ("version") 可以任意命名,僅用於識別類型:位於同一父層下、類型相同的根資料夾 可以互相切換。

完整版本管理

有時您會想為整個網站進行版本管理,例如 https://v14.fumadocs.dev (Fumadocs v14) 與 https://fumadocs.dev (最新版 Fumadocs) 。

您可以為某個版本的文件建立一個 Git 分支 (例如命名為 v2) ,並將其部署為獨立的應用程式,放在另一個子網域上,例如 v2.my-site.com。

您也可以選擇在文件中加入其他版本的連結。 相較於部分版本管理,這種做法有以下優點:

  • 易於維護:當您迭代開發或升級相依套件時,舊版文件/分支不會受到影響。
  • 一致性更佳:不只文件本身,您的首頁 (以及其他頁面) 也會一併納入版本管理。

How is this guide?

最後更新於