# はじめに

このガイドでは、空のフォルダーからOnedocsを使ったドキュメントサイトをセットアップします。すでにNext.jsプロジェクトがある場合は、用意済みのファイルを飛ばし、残りを確認してください。

## 前提条件

- Node.js 20.9以降（Next.js 16で必須）
- App Routerを備えたNext.js 16、またはReact 19.2以降
- Tailwind CSS v4（OnedocsのCSSプリセットが`tailwindcss`を読み込みます）

Fumadocs UI 16が対応するのはNext.js 16とReact 19.2のみです。そのため、`onedocs`パッケージのメタデータに記載されていても、古いNext.jsやReactのバージョンは動作しません（[#5](https://github.com/inline0/onedocs/issues/5)）。

## インストール

OnedocsにはNext.jsもFumadocsも同梱されていません。これらはピア依存関係のため、Onedocsと一緒にインストールします。

```bash
npm install onedocs fumadocs-core fumadocs-mdx fumadocs-ui lucide-react@0.562 next react react-dom
npm install -D tailwindcss @tailwindcss/postcss typescript @types/react @types/react-dom @types/node
```

`lucide-react@0.562`のバージョン固定を維持してください。`onedocs` 0.1.27は`lucide-react` `^0.562.0`をピア依存関係として宣言しています。固定しないとnpmがlucide-react 1.xをインストールし、`ERESOLVE`エラーで停止します（[#1](https://github.com/inline0/onedocs/issues/1)）。

同じパッケージはpnpm、yarn、bunでも使えます。

Next.jsスクリプトを`package.json`に追加します。

```json title="package.json"
{
  "scripts": {
    "dev": "next dev",
    "build": "next build",
    "start": "next start"
  }
}
```

## プロジェクト構成

最終的な構成は次のとおりです。

```
your-project/
├── content/
│   └── docs/
│       ├── index.mdx
│       └── meta.json
├── public/
│   └── fonts/
│       └── InterVariable.woff2
├── src/
│   ├── app/
│   │   ├── layout.tsx
│   │   ├── page.tsx
│   │   ├── globals.css
│   │   └── docs/
│   │       ├── layout.tsx
│   │       └── [[...slug]]/
│   │           └── page.tsx
│   └── lib/
│       └── source.ts
├── onedocs.config.ts
├── source.config.ts
├── next.config.mjs
├── postcss.config.mjs
├── tsconfig.json
└── package.json
```

各ファイルを作成していきましょう。

## 設定ファイル

### onedocs.config.ts

メインの設定ファイルです。必須なのは`title`だけです。その他の設定については[設定](https://onedocs.inline0.dev/ja/docs/configuration)を参照してください。

```ts title="onedocs.config.ts"
import { defineConfig } from "onedocs/config";

export default defineConfig({
  title: "My Docs",
  description: "Documentation for my project",
  nav: {
    github: "username/repo",
  },
});
```

### source.config.ts

Fumadocs MDXにコンテンツの場所を指定します。コンテンツフォルダーを設定する場所はここだけです。

```ts title="source.config.ts"
import { defineDocs } from "fumadocs-mdx/config";

export const docs = defineDocs({
  dir: "content/docs",
});
```

### next.config.mjs

MDX処理を有効にします。

```js title="next.config.mjs"
import { createMDX } from "fumadocs-mdx/next";

const withMDX = createMDX();

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

export default withMDX(config);
```

Fumadocs MDXは、Next.jsの起動時に`source.config.ts`から`.source/`フォルダーを生成します。`.source`を`.gitignore`に追加してください。

### postcss.config.mjs

OnedocsのCSSプリセットの基盤であるTailwind CSS v4を実行します。

```js title="postcss.config.mjs"
export default {
  plugins: {
    "@tailwindcss/postcss": {},
  },
};
```

### tsconfig.json

以下の例では`@/`からインポートするため、`src/`にマッピングします。

```json title="tsconfig.json"
{
  "compilerOptions": {
    "paths": {
      "@/*": ["./src/*"]
    }
  }
}
```

初めて`next dev`または`next build`を実行すると、Next.jsが必要な残りのコンパイラーオプションをこのファイルに追加します。

## ソースのセットアップ

### src/lib/source.ts

ドキュメントのコンテンツを読み込みます。

```ts title="src/lib/source.ts"
import { loader } from "fumadocs-core/source";
import { docs } from "../../.source/server";

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

## アプリのファイル

### src/app/layout.tsx

ルートレイアウトです。

```tsx title="src/app/layout.tsx"
import type { Metadata } from "next";
import { RootProvider } from "fumadocs-ui/provider/next";
import { FontHead } from "onedocs";
import "./globals.css";

export const metadata: Metadata = {
  title: "My Docs",
  description: "Documentation for my project",
};

export default function RootLayout({
  children,
}: {
  children: React.ReactNode;
}) {
  return (
    <html lang="en" suppressHydrationWarning>
      <head>
        <FontHead />
      </head>
      <body className="antialiased">
        <RootProvider>{children}</RootProvider>
      </body>
    </html>
  );
}
```

FumadocsのUIにある`RootProvider`は、検索ダイアログとライト・ダークテーマを提供します。`FontHead`は`/fonts/InterVariable.woff2`からInter Variableフォントをプリロードし、ページのフォントに設定します。Onedocsにはフォントファイルが含まれていません。[Interのリリース](https://github.com/rsms/inter/releases)から`InterVariable.woff2`をダウンロードし、`public/fonts/`に配置してください。配置しない場合、テキストにはシステムのサンセリフフォントが使われます。

設定からこのメタデータを生成する方法については、[APIリファレンス](https://onedocs.inline0.dev/ja/docs/api-reference#createmetadata)の`createMetadata`を参照してください。

### src/app/globals.css

CSSプリセットをインポートします。

```css title="src/app/globals.css"
@import "onedocs/css/preset.css";

@source "./**/*.tsx";
@source "../../content/**/*.mdx";
```

プリセットはTailwind CSS、FumadocsのUIスタイル、Onedocsのレイアウトスタイルを読み込みます。`@source`のパスは`globals.css`からの相対パスです。そのため、この2行は`src/app/`と、プロジェクトルートにある`content/`フォルダーを参照します。

### src/app/page.tsx

ホームページです。`HomePage`が設定からヒーロー、機能、フッターを描画します。

```tsx title="src/app/page.tsx"
import { HomePage } from "onedocs";
import config from "../../onedocs.config";

export default function Home() {
  return <HomePage config={config} packageName="my-package" />;
}
```

`packageName`はヒーローにnpm、yarn、pnpm、bunのインストールコマンドを追加します。プロジェクトがパッケージでない場合は省略してください。

### src/app/docs/layout.tsx

サイドバー付きのドキュメントレイアウトです。

```tsx title="src/app/docs/layout.tsx"
import { DocsLayout } from "onedocs";
import type { ReactNode } from "react";
import { source } from "@/lib/source";
import config from "../../../onedocs.config";

export default function Layout({ children }: { children: ReactNode }) {
  return (
    <DocsLayout config={config} pageTree={source.pageTree}>
      {children}
    </DocsLayout>
  );
}
```

### src/app/docs/[[...slug]]/page.tsx

個別のドキュメントページです。

```tsx title="src/app/docs/[[...slug]]/page.tsx"
import { source } from "@/lib/source";
import { DocsPage, mdxComponents } from "onedocs";
import { notFound } from "next/navigation";

export default async function Page(props: {
  params: Promise<{ slug?: string[] }>;
}) {
  const params = await props.params;
  const page = source.getPage(params.slug);
  if (!page) notFound();

  const MDX = page.data.body;

  return (
    <DocsPage toc={page.data.toc}>
      <MDX components={mdxComponents} />
    </DocsPage>
  );
}

export async function generateStaticParams() {
  return source.generateParams();
}

export async function generateMetadata(props: {
  params: Promise<{ slug?: string[] }>;
}) {
  const params = await props.params;
  const page = source.getPage(params.slug);
  if (!page) notFound();

  return {
    title: page.data.title,
    description: page.data.description,
  };
}
```

## コンテンツ

### content/docs/index.mdx

各ページのフロントマターには`title`が必要です。`description`は任意です。

```mdx title="content/docs/index.mdx"
---
title: Introduction
description: What this project does.
---

Welcome to the docs. Components such as `<Callout>` work without imports; see [Components](/docs/components).
```

### content/docs/meta.json

サイドバーの順序を設定します。

```json title="content/docs/meta.json"
{
  "pages": ["index"]
}
```

`.mdx`ファイルをもう1つ作成し、その名前を`pages`に記載すると、ページを追加できます。

## 実行

開発サーバーを起動します。

```bash
npm run dev
```

ホームページは`http://localhost:3000`、ドキュメントは`http://localhost:3000/docs`にあります。

本番用にビルドします。

```bash
npm run build
```

次に、[SEOと検索](https://onedocs.inline0.dev/ja/docs/seo-search)で検索、サイトマップ、llms.txtを追加します。