# Начало работы

Это руководство поможет создать сайт документации с Onedocs в пустой папке. Если у вас уже есть проект Next.js, пропустите уже имеющиеся файлы и сверьтесь с остальными.

## Предварительные требования

- Node.js 20.9 или новее (требуется для Next.js 16)
- Next.js 16 с App Router, React 19.2 или новее
- Tailwind CSS v4 (пресет Onedocs CSS импортирует `tailwindcss`)

Fumadocs UI 16 поддерживает только Next.js 16 и React 19.2, поэтому более старые версии Next.js или React не работают, хотя в метаданных пакета `onedocs` они по-прежнему указаны ([#5](https://github.com/inline0/onedocs/issues/5)).

## Установка

Onedocs не включает в комплект Next.js или Fumadocs. Это одноранговые зависимости, поэтому установите их рядом с ним:

```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/ru/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/` из `source.config.ts`. Добавьте `.source` в `.gitignore`.

### postcss.config.mjs

Запускает Tailwind CSS v4, на основе которого создан пресет Onedocs CSS:

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

`RootProvider` из Fumadocs UI предоставляет диалог поиска и светлую и темную темы. `FontHead` предварительно загружает шрифт Inter Variable из `/fonts/InterVariable.woff2` и задает его для страницы. Onedocs не содержит файл шрифта: скачайте `InterVariable.woff2` из [выпусков Inter](https://github.com/rsms/inter/releases) и поместите его в `public/fonts/`. Без него текст будет отображаться системным шрифтом без засечек.

Чтобы вместо этого создать эти метаданные из конфигурации, см. `createMetadata` в справочнике [API Reference](https://onedocs.inline0.dev/ru/docs/api-reference#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`, поэтому эти две строки указывают на `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

Для каждой страницы в frontmatter обязательно поле `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` и указав его имя в `pages`.

## Запуск

Запустите сервер разработки:

```bash
npm run dev
```

Главная страница находится по адресу `http://localhost:3000`, а документация — по адресу `http://localhost:3000/docs`.

Сборка для production:

```bash
npm run build
```

Затем добавьте поиск, карту сайта и llms.txt в разделе [SEO и поиск](https://onedocs.inline0.dev/ru/docs/seo-search).