手動インストール

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 に必要なスタイルを追加してください。

src/routes/__root.tsx

import { createRootRoute, HeadContent, Outlet, Scripts } from '@tanstack/react-router';
import * as React from 'react';
import { RootProvider } from 'fumadocs-ui/provider/tanstack';

export const Route = createRootRoute({
  component: RootComponent,
});

function RootComponent() {
  return (
    <RootDocument>
      <Outlet />
    </RootDocument>
  );
}

function RootDocument({ children }: { children: React.ReactNode }) {
  return (
    <html suppressHydrationWarning>
      <head>
        <HeadContent />
      </head>
      <body className="flex flex-col min-h-screen">
        <RootProvider>{children}</RootProvider>
        <Scripts />
      </body>
    </html>
  );
}

ルート

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

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>;
}

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

完了

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

content/docs/index.mdx

---
title: Hello World
---

## Introduction

I love Fumadocs.

手動インストール

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

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

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

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

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

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

このページの内容

前提条件

はじめに

スタイル

Root Provider

ルート

完了