LogoMkSaaS 文件

什麼是 Fumadocs

介紹 Fumadocs,一個可以自由發揮的文件框架

Fumadocs 的誕生是因為我想要一個更加客製化的文件建置體驗,一個不強加意見的文件框架,一個你可以「打破」的「框架」

設計理念

更少的抽象化: Fumadocs 期望你寫程式碼並與你的其他軟體協作。 雖然大多數框架都是透過設定檔進行配置,但當你希望調整其細節時,它們通常缺乏彈性。 你無法控制它們如何渲染頁面或內部邏輯。Fumadocs 展示應用程式如何運作,而不是只提供單一的設定檔。

Next.js 基礎: 它為你提供實用工具和美觀的 UI。 你仍然使用 Next.js App Router 的功能,像是靜態網站生成。對 Next.js 開發者來說沒有新的東西,所以你可以安心使用。

對 UI 有自己的想法: Fumadocs UI(預設主題)提供的唯一東西是使用者介面。UI 的設計理念是帶來更好的行動版響應式設計和使用者體驗。 相反地,我們使用受 Shadcn UI 啟發的更靈活方法 — Fumadocs CLI,這樣我們可以快速迭代設計,並歡迎更多關於 UI 的回饋。

為什麼選擇 Fumadocs

Fumadocs 的設計考量了靈活性。

你可以將 fumadocs-core 用作無頭 UI 函式庫並帶入你自己的樣式。 Fumadocs MDX 也是在 Next.js 中處理 MDX 內容的實用函式庫。它還包括:

  • 許多內建元件。
  • Typescript Twoslash、OpenAPI 和 Math (KaTeX) 整合。
  • 預設快速且最佳化,原生建構在 App Router 上。
  • 與 Next.js 緊密整合,你可以輕鬆將其加入現有的 Next.js 專案中。

如果你有興趣,可以閱讀比較

文件

Fumadocs 專注於撰寫體驗,它提供了一個美觀的主題和許多文件自動化工具。

它幫助你更快地迭代程式碼庫,同時不會讓你的文件落後。 你可以將此網站作為使用 Fumadocs 建置的文件網站範例。

部落格網站

由於 Next.js 已經是一個強大的框架,大多數功能可以僅使用 Next.js 實作。

Fumadocs 為 Next.js 提供了額外的工具,包括語法醒目提示、文件搜尋和預設主題(Fumadocs UI)。 它幫助你避免重新發明輪子。

何時使用 Fumadocs

對於大多數的網頁應用程式,原生 React.js 已經不夠用了。 現在,我們也希望有部落格、展示頁面、FAQ 頁面等等。搭配令人驚豔的精美 UI,在這些情況下,Fumadocs 可以幫助你更輕鬆地建置文件,減少樣板程式碼。

Fumadocs 由 Fuma 和許多貢獻者維護,關注程式碼庫的可維護性。 雖然我們不打算提供人們想要的每一項功能,但我們更專注於使基本功能完美且維護良好。 你也可以透過貢獻來幫助 Fumadocs 變得更加實用!