クイックスタート
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 devhttp://localhost:4321/docs を開くと、作成したページを確認できます。
よくある質問
よく寄せられる質問をまとめています。
お探しのAPIや修正は、新しいバージョンで提供されている可能性があります。Fumadocsをアップグレードしてから、もう一度お試しください。
ルーティングは Astro が処理します。まず docs ルートを移動してください (/docs/* -> /info/*) 。
src/pages/docs を src/pages/info に移動します。
最後に、source.ts でページのベース URL を更新します。
import { loader } from 'fumadocs-core/source';
export const source = loader({
baseUrl: '/info', // 新しい値に変更
});テンプレートでは、この値は lib/shared.ts 内で docsRoute として定義されています。Markdown のリンクにも反映されるよう、変更する際はこの値を編集してください。
レイアウトタブの使用をおすすめします。
Docs アイランドを使用しない独立した .astro ページを src/pages/docs/ に作成します。同じ URL が重複しないよう、content/docs から対応する MDX ファイルを削除してください。
さらに詳しく
初めての方もご安心ください。ご質問はいつでも歓迎しています。
わかりにくい点があれば、Github Discussion でぜひフィードバックをお寄せください!
コンテンツの執筆
ドキュメントを執筆する際は、以下を必ずお読みください。
Markdown
Fumadocs には、コンテンツ執筆に役立つ追加機能がいくつか用意されています。
ナビゲーション
ナビゲーション構造をカスタマイズする方法を説明します。
ページスラッグとページツリー
コンテンツを整理する方法を説明します。
コンポーネント
ドキュメントを充実させるために利用できるコンポーネントの一覧です
特殊な要件
How is this guide?
