Formion LogoMkSaaS文檔
Formion LogoMkSaaS文檔
首頁

介紹

快速入門什麼是 Fumadocs對比

設置

手動安裝靜態導出

寫作

Markdown國際化

UI

概覽主題搜尋
組件
MDX
X (Twitter)

對比

Fumadocs 與其他現有框架有何不同?

Nextra

Fumadocs 深受 Nextra 啟發。例如,路由約定。這就是為什麼 Fumadocs 中也存在 meta.json。

Nextra 比 Fumadocs 更加固執己見。Fumadocs 由 App Router 加速。因此,它提供了許多伺服器端功能,與簡單編輯配置文件相比,您必須手動配置一些內容。

如果您想要對一切都有更多的控制,比如將其添加到現有代碼庫或實現高級路由,Fumadocs 會表現得很出色。

功能表

功能FumadocsNextra
靜態生成是是
緩存是是
明/暗模式是是
語法高亮是是
目錄是是
全文搜尋是是
國際化是是
最後 Git 編輯時間是是
頁面圖標是是,通過 _meta.js 文件
RSC是是
遠程源是是
SEO通過元數據是
內置組件是是
RTL 佈局是是

附加功能

通過第三方庫支持的功能(如 TypeDoc)不會在此列出。

功能FumadocsNextra
OpenAPI 集成是否
TypeScript 文檔生成是否
TypeScript Twoslash是是

Mintlify

Mintlify 是一項文檔服務,與 Fumadocs 相比,它提供免費套餐,但並非完全免費和開源。

Fumadocs 不如 Mintlify 強大,例如 Mintlify 的 OpenAPI 集成。 作為 Fumadocs 的創建者,如果您對當前構建文檔的方式感到滿意,我不建議從 Mintlify 切換到 Fumadocs。 然而,我相信 Fumadocs 是所有想要擁有優雅文檔的 Next.js 開發者的合適工具。

Docusaurus

Docusaurus 是一個基於 React.js 的強大框架。它通過插件和自定義主題提供了許多酷炫的功能。

更好的開發者體驗

由於 Fumadocs 構建在 Next.js 之上,您每次都必須啟動 Next.js 開發伺服器來查看更改,並且相對於 Docusaurus,初始樣板代碼較多。

對於簡單的文檔,如果您不需要任何特定於 Next.js 的功能,Docusaurus 可能是更好的選擇。

然而,當您想要使用 Next.js,或尋求更多的可客製性,如調整預設 UI 組件時,Fumadocs 可能是更好的選擇。

插件

您可以通過插件輕鬆實現許多功能,他們的生態系統確實更大,並由許多貢獻者維護。

相比之下,Fumadocs 的靈活性允許您自己實現它們,可能需要更長的時間來調整它以達到您的滿意度。

什麼是 Fumadocs

介紹 Fumadocs,一個可以打破常規的文檔框架

手動安裝

從零開始創建一個新的 Fumadocs 項目

目錄

Nextra
功能表
附加功能
Mintlify
Docusaurus
更好的開發者體驗
插件