快速入門
開始使用 Fumadocs
Using an AI agent?
Copy the instructions into your agent (Claude Code, Cursor, Codex, etc.) to set up a new docs site, or to add Fumadocs to an existing app. For other tasks, give it fumadocs.dev/llms.txt, which lists every docs page as Markdown.
術語
Markdown/MDX: Markdown 是一種用來撰寫格式化文字的標記語言。Fumadocs 原生支援 Markdown 與 MDX (Markdown 的超集) 。
Bun: 一種 JavaScript 執行階段,本指南會使用它來執行指令碼。如果您偏好 Node.js,可以改用 unrun。
若想進一步自訂,具備一些 React.js 基礎知識會很有幫助。
自動安裝
需要 Node.js 22 或以上版本。
npm create fumadocs-app系統會詢問您要使用哪一個內建範本:
- 框架:Next.js、React Router、TanStack Start、Waku 和 Astro。
- 內容來源:Fumadocs MDX 或 Astro 內容集合。
接著會初始化一個新的 Fumadocs 應用程式,並預設設定好以下功能:
要從現有的程式碼庫開始?
您可以參考手動安裝指南來開始使用。
開始享受吧!
請在 docs 資料夾中建立您的第一個 MDX 檔案。
---
title: Hello World
---
## Yo what's up以開發模式執行應用程式:
npm run dev開啟 http://localhost:3000/docs 即可查看您的頁面。
常見問題
以下整理了您可能會遇到的一些常見問題。
該 API 或修正可能只在較新的版本中提供。請升級 Fumadocs 後再試一次。
路由由 Next.js 處理。請先移動文件路由 (/docs/* -> /info/*) 。
重新命名路由:
或使用路由群組,將 /docs/* 改為 /*:
最後,請在 source.ts 中更新頁面的基礎 URL:
import { loader } from 'fumadocs-core/source';
export const source = loader({
baseUrl: '/info', // 改成新的路徑
});範本在 lib/shared.ts 中將此值定義為 docsRoute,請在該處修改,Markdown 連結便會隨之更新。
建議使用版面配置頁籤。
做法與在 Next.js App Router 中管理版面配置相同:請先從內容目錄 (/content/docs) 中移除原本的 MDX 檔案,
以免重複的頁面造成錯誤。
接著,您可以將該頁面放到另一個路由群組中,且該群組不能位於文件版面配置之下。
例如,若要取代 /docs/test:
若是 /docs,您需要將 catch-all 路由改為非選用:
如果您遇到類似以下的 Turbopack 錯誤:
JSON file not found: FileSystemPath { ... path: "lib/locales/sources/file.json.json" }這通常是因為不支援 require(esm) (#3312) ,請升級至 Node.js 22 以上版本。
若您在 Node.js 23.1 上進行正式環境建置時遇到以下錯誤:
Could not find a production build in the '.next' directory.這是已知問題,請參閱 #1021。您可以將 Node.js 升級至 23.6.0 以上版本。
只要設定了 generateStaticParams,Next.js 就會將動態路由轉換為靜態路由。
因此,其速度與靜態頁面一樣快。
您可以啟用靜態匯出,以產生靜態的建置輸出。
深入了解
剛開始接觸嗎?別擔心,我們非常歡迎您提出任何問題。
如果有任何令您困惑的地方,歡迎到 Github Discussion 提供您的意見回饋!
撰寫內容
撰寫文件前,請務必閱讀:
特殊需求
How is this guide?
最後更新於
