
什麼是 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
對於大多數 Web 應用程序,原生 React.js 已經不夠用了。 如今,我們還希望有一個博客、展示頁面、FAQ 頁面等。帶有令人驚歎的精美 UI,在這些情況下,Fumadocs 可以幫助您更輕鬆地構建文檔,減少樣板代碼。
Fumadocs 由 Fuma 和許多貢獻者維護,關注代碼庫的可維護性。 雖然我們不打算提供人們想要的每一項功能,但我們更專注於使基本功能完美且維護良好。 您也可以通過貢獻來幫助 Fumadocs 變得更加有用!
郵件列表
加入我們的社區
訂閱郵件列表,及時獲取最新消息和更新


