手動インストール

Fumadocs CLI を使って自動でセットアップすることもできます。

npx @fumadocs/cli init

前提条件

先に進む前に、以下が設定済みであることを確認してください。

Tailwind CSS 4
Fumadocs MDX：Vite セットアップガイドに従って、lib/source.ts などの必須ファイルを作成してください。

補足

Fumadocs は、Content Collections やヘッドレス CMS など、ほかのコンテンツソースにも対応しています。

はじめに

パッケージをインストールします。

npm i fumadocs-core fumadocs-ui@npm:@fumadocs/base-ui

テンプレートと同様に、このコマンドでは fumadocs-ui を、Fumadocs UI の Base UI 版である @fumadocs/base-ui のエイリアスとしてインストールします。Radix UI を使う場合は、エイリアスなしで fumadocs-ui をインストールしてください。

スタイル

Tailwind CSS ファイルに以下を追加します。

@import 'tailwindcss';
@import 'fumadocs-ui/css/neutral.css';
@import 'fumadocs-ui/css/preset.css';

Root Provider

アプリ全体を Root Provider でラップし、body に必要なスタイルを追加してください。

app/root.tsx

import { Links, Meta, Scripts, ScrollRestoration } from 'react-router';
import { RootProvider } from 'fumadocs-ui/provider/react-router';
import './app.css';

export function Layout({ children }: { children: React.ReactNode }) {
  return (
    <html lang="en" suppressHydrationWarning>
      <head>
        <meta charSet="utf-8" />
        <meta name="viewport" content="width=device-width, initial-scale=1" />
        <Meta />
        <Links />
      </head>
      <body className="flex flex-col min-h-screen">
        <RootProvider>{children}</RootProvider>
        <ScrollRestoration />
        <Scripts />
      </body>
    </html>
  );
}

ルート

ルートを更新します。

app/routes.ts

import { type RouteConfig, index, route } from '@react-router/dev/routes';

export default [
  index('routes/home.tsx'),
  route('docs/*', 'routes/docs.tsx'),
  route('api/search', 'routes/search.ts'),
] satisfies RouteConfig;

次のファイルを作成します。

import defaultMdxComponents from 'fumadocs-ui/mdx';
import type { MDXComponents } from 'mdx/types';

export function getMDXComponents(components?: MDXComponents) {
  return {
    ...defaultMdxComponents,
    ...components,
  } satisfies MDXComponents;
}

export const useMDXComponents = getMDXComponents;

declare global {
  type MDXProvidedComponents = ReturnType<typeof getMDXComponents>;
}

RSC モードでは、docs ルートはローダーとページコンポーネントの代わりに ServerComponent をエクスポートします。

app/routes/docs.tsx

import type { Route } from './+types/docs';
import { DocsLayout } from 'fumadocs-ui/layouts/docs';
import { DocsBody, DocsDescription, DocsPage, DocsTitle } from 'fumadocs-ui/layouts/docs/page';
import { source } from '@/lib/source';
import defaultMdxComponents from 'fumadocs-ui/mdx';
import { baseOptions } from '@/lib/layout.shared';

export function ServerComponent({ params }: Route.ComponentProps) {
  const slugs = params['*'].split('/').filter((v) => v.length > 0);
  const page = source.getPage(slugs);
  if (!page) throw new Response('Not found', { status: 404 });

  const { body: MDX } = page.data;

  return (
    <DocsLayout {...baseOptions()} tree={source.getPageTree()}>
      <DocsPage toc={page.data.toc}>
        <title>{page.data.title}</title>
        <meta name="description" content={page.data.description} />
        <DocsTitle>{page.data.title}</DocsTitle>
        <DocsDescription>{page.data.description}</DocsDescription>
        <DocsBody>
          <MDX components={{ ...defaultMdxComponents }} />
        </DocsBody>
      </DocsPage>
    </DocsLayout>
  );
}

検索ルートでは ZBSearch を使用しています。設定方法についてはドキュメント検索を参照してください。

完了

開発サーバーを起動し、content/docs にドキュメントを作成してください。

content/docs/index.mdx

---
title: Hello World
---

## Introduction

I love Fumadocs.

手動インストール

前提条件アンカーリンクをコピー

はじめにアンカーリンクをコピー

スタイルアンカーリンクをコピー

Root Providerアンカーリンクをコピー

ルートアンカーリンクをコピー

完了アンカーリンクをコピー

このページの内容

前提条件

はじめに

スタイル

Root Provider

ルート

完了