create-fumadocs-app

使用方式

npx create-fumadocs-app@latest my-docs

執行時會詢問要使用的範本與要設定的功能，您也可以直接透過選項傳入。

選項	說明
`--template <name>`	要使用的範本，請參閱範本。
`--src`	(僅限 Next.js) 使用 `src/` 目錄。
`--linter <name>`	設定 linter：`eslint` (僅限 Next.js) 、`oxlint` 或 `biome`。
`--search <name>`	搜尋方案：`orama` (預設，本機搜尋) 、`orama-cloud`、`algolia`、`meilisearch`、`typesense` 或 `mixedbread` (需要伺服器) 。
`--og-image <name>`	OG 圖片：`next-og` (僅限 Next.js) 或 `takumi`，其他框架一律使用 Takumi。
`--ai-chat <name>`	AI 聊天：`openrouter`、`llmgateway` 或 `inkeep`，不適用於靜態、SPA 及 Astro 範本。
`--install`	自動安裝相依套件。
`--no-git`	略過 Git 儲存庫初始化。
`--pm <name>`	套件管理器：`npm`、`pnpm`、`yarn` 或 `bun`，會依據呼叫 CLI 的方式自動偵測。
`-y, --yes`	略過互動提示，未指定的選項一律使用預設值。

傳入 --yes 即可略過所有提示，適合在指令碼、CI 及 AI 代理中使用：

npx create-fumadocs-app@latest my-docs --template +next+fuma-docs-mdx --install --yes

未指定的選項會使用預設值：不使用 linter、使用本機搜尋、不啟用 AI 聊天。若目標目錄已存在且不是空的，指令會執行失敗。

範本沒有提供 i18n 選項。若要為新專案加入 i18n，請參考對應框架的國際化指南：Next.js、React Router、TanStack Start、Waku 或 Astro。

除了傳統的 CLI 用法之外，您也可以在指令碼中使用它，例如：

npm install create-fumadocs-app

import { create } from 'create-fumadocs-app';

await create({
  outputDir: 'my-app',
  template: '+next+fuma-docs-mdx',
  packageManager: 'pnpm',
});