手動インストール
既存のAstroプロジェクトにFumadocsを追加します。
Fumadocs CLI にセットアップを任せることもできます。
npx @fumadocs/cli init前提条件
先に進む前に、以下が設定済みであることを確認してください。
- Node.js 22.23.4 以降 (Astro の要件)
- Tailwind CSS 4
このガイドでは、コンテンツソースとして Astro の content collections を使用します。@fumadocs/astro はこれを Fumadocs でコンパイルし、MDX を React アイランドとしてレンダリングします。
はじめに
パッケージをインストールします。
npm i fumadocs-core fumadocs-ui@npm:@fumadocs/base-ui @fumadocs/astro @astrojs/react react react-dom @types/mdxテンプレートと同様に、このコマンドでは fumadocs-ui を @fumadocs/base-ui (Fumadocs UI の Base UI 版) のエイリアスとしてインストールします。Radix UI を使用する場合は、エイリアスなしで fumadocs-ui をインストールしてください。
スタイル
Tailwind CSS ファイルに以下を追加します。
@import 'tailwindcss';
@import 'fumadocs-ui/css/neutral.css';
@import 'fumadocs-ui/css/preset.css';インテグレーション
Astro の設定に Fumadocs インテグレーションを追加します。
import { defineConfig } from 'astro/config';
import tailwindcss from '@tailwindcss/vite';
import fumadocs from '@fumadocs/astro';
export default defineConfig({
integrations: [fumadocs({ components: './src/components/mdx.tsx' })],
vite: {
plugins: [tailwindcss()],
},
});コンテンツコレクション
コンテンツコレクションを定義します。
import { defineCollection } from 'astro:content';
import { metaLoader, pageLoader } from '@fumadocs/astro/loaders';
export const collections = {
docs: defineCollection({ loader: pageLoader() }),
meta: defineCollection({ loader: metaLoader() }),
};
定義したコレクションから Fumadocs のソースを作成します。
import { getCollection } from 'astro:content';
import { loader } from 'fumadocs-core/source';
import { toFumadocsSource } from '@fumadocs/astro/source';
export const source = loader({
source: toFumadocsSource(await getCollection('docs'), await getCollection('meta')),
baseUrl: '/docs',
});
1つの loader() で他のソースと組み合わせる場合は、toFumadocsSource() の第3引数に { baseDir } を渡すと、そのファイルを特定のディレクトリ配下に配置できます。
ルート
以下のファイルを作成します。
import defaultMdxComponents from 'fumadocs-ui/mdx';
import { DocsBody } from 'fumadocs-ui/layouts/docs/page';
import type { MDXComponents } from 'mdx/types';
export function getMDXComponents(components?: MDXComponents) {
return {
...defaultMdxComponents,
...components,
} satisfies MDXComponents;
}
// for the Fumadocs integration, `wrapper` gives the content its prose styles
export default getMDXComponents({ wrapper: DocsBody });
検索ルートでは ZBSearch を使用しています。設定方法についてはドキュメント検索を参照してください。
完了
開発サーバーを起動して、content/docs にドキュメントを書きましょう。
---
title: Hello World
---
## Introduction
I love Fumadocs.How is this guide?
