手動インストール

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

npx @fumadocs/cli init

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

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

• Next.js 16
• Tailwind CSS 4

このガイドでは、コンテンツソースとして Fumadocs MDX を使用します。まずはこれを設定してください。

npm i fumadocs-mdx fumadocs-core @types/mdx

import { createMDX } from 'fumadocs-mdx/next';

/** @type {import('next').NextConfig} */
const config = {
  reactStrictMode: true,
};

const withMDX = createMDX();

export default withMDX(config);

import { defineDocs } from 'fumadocs-mdx/macro';
import { loader } from 'fumadocs-core/source';

const docs = defineDocs({
  dir: 'content/docs',
});

export const source = loader({
  baseUrl: '/docs',
  source: docs.toFumadocsSource(),
});

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

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

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

import { RootProvider } from 'fumadocs-ui/provider/next';
import type { ReactNode } from 'react';

export default function Layout({ children }: { children: ReactNode }) {
  return (
    <html lang="en" suppressHydrationWarning>
      <body
        // 必須のスタイル
        className="flex flex-col min-h-screen"
      >
        <RootProvider>{children}</RootProvider>
      </body>
    </html>
  );
}

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

レイアウトで共有するオプションを1つのファイルにまとめます。

import type { BaseLayoutProps } from 'fumadocs-ui/layouts/shared';

export function baseOptions(): BaseLayoutProps {
  return {
    nav: {
      title: 'My App',
    },
  };
}

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

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 にドキュメントを作成してください。

---
title: Hello World
---

## Introduction

I love Fumadocs.