---
language: "ru"
title: "Начало работы"
canonical: "https://cookbook.tenphi.me/ru/getting-started/"
source: "docs/ru/getting-started.md"
version: "0.28.0"
index: true
---

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

Для Cookbook требуется Node.js 22.19 или новее.

## Создайте первый сайт

```sh
npm create @tenphi/cookbook@latest my-docs -- --yes
cd my-docs
npm run dev
```

Мастер создаст README, конфигурацию Astro и `docs.config.ts`, а затем установит зависимости. Он также создаст `AGENTS.md` с инструкциями для программирующих агентов. Измените `README.md`, чтобы обновить главную страницу. Добавьте `docs/guide.md`, чтобы создать маршрут `/guide`. Новые и изменённые страницы появляются на сервере разработки без перезапуска.

## Опишите существующий репозиторий

Выполните команды из корня репозитория:

```sh
npm create @tenphi/cookbook@latest docs-site -- --source . --yes
cd docs-site
npm run dev
```

Созданный `docs.config.ts` ссылается на ваш репозиторий. Корневой README становится главной страницей, а `docs/**/*.{md,mdx}` — остальными страницами. Cookbook читает эти файлы без копирования или изменения.

Флаг `--no-install` позволяет создать файлы без установки зависимостей. В неинтерактивном режиме мастер не перезаписывает непустой целевой каталог.

## Опишите опубликованный npm-пакет

```sh
npm create @tenphi/cookbook@latest my-package-docs -- \
  --package @scope/package@latest --yes
cd my-package-docs
npm run dev
```

Мастер находит документацию в опубликованном пакете и записывает его точную версию и контрольную сумму в `cookbook.lock.json`. Добавьте этот файл в Git. Документируемый пакет не устанавливается, а его скрипты не запускаются. Выполните `npm run update`, когда понадобится заново определить версию по указанному тегу или диапазону.

## Добавьте Cookbook в существующий проект Astro

Для Cookbook требуется настройка Astro `output: "static"`. Если проект использует `output: "server"`, создайте отдельный статический проект Astro для документации.

```sh
npx astro add @tenphi/cookbook
```

В конфигурации Astro нужна одна интеграция:

```ts
import { defineConfig } from "astro/config";
import cookbook from "@tenphi/cookbook";

export default defineConfig({ integrations: [cookbook()] });
```

Cookbook включает собственный рендерер Astro и автоматически находит `docs.config.ts`. Без конфигурации документации он следует соглашениям для README и каталога `docs/`.

## Настройте сайт

Начните с готовых [рецептов для фирменного стиля, логотипа и шрифтов](/recipes/). Более глубокие изменения стилей и создание компонентов описаны в [правилах настройки](/customization-rules/). Эти правила и ссылки на первоисточники также входят в установленный пакет Cookbook.

Создайте `docs.config.ts` рядом с `astro.config.ts`:

```ts
import { defineDocsConfig } from "@tenphi/cookbook/config";

export default defineDocsConfig({
  site: {
    title: "Example Project",
    description: "Documentation for Example Project",
    repository: "https://github.com/example/project",
  },
  theme: {
    brand: { from: "#2f5bff" },
    fonts: { body: "Inter", heading: "Newsreader" },
  },
});
```

В `theme.fonts` можно указать [Google Fonts по имени или собственные файлы шрифтов](/fonts-and-typography/). Для типографики используйте `theme.presets`, для встроенных элементов — `theme.styles`, а для новых элементов — `defineComponent()` вместе с `theme.customStyles`. Начните с [руководства по теме](/theme-and-components/); все настраиваемые части перечислены в [справочнике стилей компонентов](/component-styles/).

Интеграция и CLI загружают одну и ту же конфигурацию. Поддерживаются `docs.config.ts`, `.mts`, `.js` и `.mjs` именно в таком порядке. Явный объект `config` в интеграции имеет приоритет; `configFile: false` отключает обнаружение файла. Для нестандартного расположения используйте `cookbook({ configFile: "./config/manual.ts" })` и `cookbook doctor --config ./config/manual.ts`.

## Корневой каталог монорепозитория

Приложение в `apps/docs/` может использовать материалы всего репозитория:

```ts
import { defineDocsConfig } from "@tenphi/cookbook/config";

export default defineDocsConfig({ root: "../.." });
```

Значение `root` указывается относительно файла конфигурации документации. Оно определяет расположение контента, локальных ресурсов и `cookbook.lock.json`. Запустите `npm run doctor` из каталога приложения: команда найдёт тот же корень, что и интеграция. Для сайта с несколькими пакетами каждый источник также может задать свой корень.

## Проверьте и опубликуйте

```sh
npm run validate
npm run preview
```

Остальные руководства пока доступны на английском языке: [примеры](/examples/), [компоненты для авторов](/authoring/), [работа с ИИ-агентами](/ai-agents/), [развёртывание](/deployment/) и [обновление между версиями](/migration/). Для полной конфигурации начните с [рецептов](/recipes/). Если проверка завершилась ошибкой, см. [решение проблем](/troubleshooting/).