跳至內容
Fumadocs

什麼是 Fumadocs

認識 Fumadocs:一個任您拆解改造的文件框架。

Fumadocs 框架指的是 UI + Core + 內容來源的組合。與其說是框架,Fumadocs 更像是一種思維框架,其中每一層都能各自作為獨立的函式庫使用。

設計理念

Fumadocs 的誕生,是為了讓建置文件的過程更具自訂彈性,成為一個不預設立場、不強加既定做法的文件框架,一個您可以打破的「框架」。

更少的抽象化

雖然大多數框架都透過設定檔進行設定,但當您想微調細節時,往往不夠有彈性。 您既無法控制它們如何算繪頁面,也無法掌控其內部邏輯。

Fumadocs 希望您自行撰寫程式碼,並與軟體的其他部分協同運作。它不仰賴設定檔,而是讓您清楚了解應用程式的運作方式,並可完全自訂。

無縫整合

Fumadocs 與您的 React 框架緊密整合,提供實用的工具與美觀的 UI。

您依然可以使用框架原有的功能,例如靜態網站生成 (Static Site Generation) 。框架的一切仍是您熟悉的樣子。

可組合的 UI

Fumadocs UI (預設主題) 唯一提供的就是使用者介面。這套 UI 有其既定的設計主張,目的是提供更好的行動裝置響應式設計與使用者體驗。

不過,我們採用受 Shadcn UI 啟發、彈性更高的做法。Fumadocs CLI 讓您能「fork」Fumadocs UI 的其中一部分,並完全自訂。

伺服器優先的做法

傳統上,靜態網站產生器都是靜態的。

然而,Fumadocs 採用了以 React 伺服器元件為基礎的伺服器優先做法。 透過明確劃分伺服器與用戶端的邊界,內容得以動態呈現並具備互動性。

您可以從伺服器擷取資料來顯示內容,或整合 CMS 以接收即時更新。內容始終保持最新,且易於維護。

精簡

Fumadocs 由 Fuma 與眾多貢獻者共同維護,並注重程式碼庫的可維護性。

我們並不打算滿足大家想要的每一項功能,而是更專注於把基本功能做到完善,並持續妥善維護。 您也可以透過貢獻,讓 Fumadocs 變得更加實用!

何時使用 Fumadocs

Fumadocs 在設計上注重彈性,不侷限於特定的使用情境。

  • fumadocs-core 是用於建構文件的無頭式 UI 函式庫。
  • fumadocs-mdx 是處理 MDX 內容的實用函式庫。

對大多數 Web 應用程式來說,單靠原生 React.js 已經不夠用了。 現在我們往往還需要部落格、作品展示頁、常見問題頁等。在這些情況下,Fumadocs 能協助您更輕鬆地建構 文件,並減少樣板程式碼。

如果您有興趣,可以參閱比較。

文件

Fumadocs 專注於撰寫體驗,提供美觀的主題以及多種文件自動化工具。

它能協助您更快速地迭代程式碼庫,同時確保文件始終跟上進度。 本網站就是使用 Fumadocs 建置的文件網站範例,可供您參考。

部落格網站

大多數 React.js 框架本身就足以滿足部落格網站的需求。

Fumadocs 另外提供了語法突顯、文件搜尋,以及預設主題 (Fumadocs UI) 等工具。 讓您不必重新發明輪子。

How is this guide?