はじめに
コアライブラリの導入ガイド
Fumadocs Core とは
Fumadocs Core は、Next.js、React Router、TanStack Start、Waku、Astro などの React.js フレームワークでドキュメントを構築するための、サーバーサイド関数とヘッドレスコンポーネントを提供します。
- 検索
- パンくずリスト、サイドバー、目次のコンポーネント
- Remark/Rehype プラグイン
- AIエージェントがドキュメントを検索・閲覧するための MCP ツール
- その他のユーティリティ
ヒント
Fumadocs UI なしでも使用できます。つまり、ヘッドレスなライブラリです。
初心者の方や一般的な用途には、Fumadocs UI の使用をおすすめします。
インストール
コアパッケージをインストールします。インテグレーションによっては追加の依存関係が必要になる場合があり、それらは各インテグレーションのガイドに記載されています。
npm install fumadocs-core一部のコンポーネントでは、フレームワークプロバイダーが必要です。
import type { ReactNode } from 'react';
import { NextProvider } from 'fumadocs-core/framework/next';
export function RootLayout({ children }: { children: ReactNode }) {
// Fumadocs UI を使用している場合は、代わりに `<RootProvider />` を使用してください
return <NextProvider>{children}</NextProvider>;
}APIとコンポーネントの一覧です:
How is this guide?
