跳至內容
Fumadocs

快速入門

開始使用 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 檔案。

content/docs/index.mdx
---
title: Hello World
---

## Yo what's up

以開發模式執行應用程式:

npm run dev

開啟 http://localhost:3000/docs 即可查看您的頁面。

常見問題

以下整理了一些您可能會遇到的常見問題。

深入了解

第一次接觸嗎?別擔心,我們非常歡迎您提出問題。

如果有任何不清楚的地方,歡迎到 Github Discussion 提供您的意見回饋!

撰寫內容

撰寫文件前,請務必閱讀:

特殊需求

How is this guide?