> For AI agents: the complete documentation index is available at /rspress-russian/llms.txt, the full documentation bundle is available at /rspress-russian/llms-full.txt.

# Быстрый старт \{#quick-start}


Для вашего агента

Запустите проект Rspress одной командой

Скопировать

Создай проект Rspress, следуя официальному руководству по быстрому старту по адресу
https://rspress.rs/guide/start/getting-started.md.

1. Создай проект с помощью `create rspress@latest`.
2. Установи зависимости.
3. Запусти сервер разработки.

## Подготовка окружения

Rspress поддерживает использование [Node.js](https://nodejs.org/), [Deno](https://deno.com/) или [Bun](https://bun.sh/) в качестве среды выполнения JavaScript.

Следуйте одному из следующих руководств по установке, чтобы настроить среду выполнения:

- [Установка Node.js](https://nodejs.org/en/download)
- [Установка Bun](https://bun.com/docs/installation)
- [Установка Deno](https://docs.deno.com/runtime/getting_started/installation/)

:::tip Требования к версии

Rspress требует Node.js версии 20.19+ или 22.12+.

:::

## Создание проекта Rspress \{#create-a-rspress-project}

Рекомендуемый способ начать новый проект Rspress — использовать утилиту `create-rspress`:


```sh [npm]
npm create rspress@latest
```

```sh [yarn]
yarn create rspress
```

```sh [pnpm]
pnpm create rspress@latest
```

```sh [bun]
bun create rspress@latest
```

```sh [deno]
deno init --npm rspress@latest
```

Утилита запросит название проекта или путь к нему, нужно ли настроить i18n, создавать ли папку `theme` для кастомизации, а также какие дополнительные инструменты или возможности добавить.

По умолчанию утилита инициализирует Git-репозиторий в созданном проекте. Передайте `--no-git`, чтобы пропустить инициализацию.

После создания проекта следуйте инструкциям, которые появятся в терминале:

```bash
cd rspress-project
git init # опционально
npm install
npm run dev
```

После запуска dev-сервер отобразит локальный URL-адрес. Откройте его в браузере, чтобы просмотреть сгенерированный сайт документации.

### Шаблоны

Rspress предоставляет следующие встроенные шаблоны:

| Шаблон        | Описание                                                                             |
| ------------- | ------------------------------------------------------------------------------------ |
| `basic`       | Создаёт минимальный сайт документации Rspress, использующий тему по умолчанию.       |
| `basic-theme` | Создаёт одноязычный сайт с папкой `theme` для кастомизации.                          |
| `i18n`        | Создаёт многоязычный сайт документации с контентом на английском и китайском языках. |
| `i18n-theme`  | Создаёт многоязычный сайт с папкой `theme` для кастомизации.                         |

### Дополнительные инструменты

При создании проекта вы можете выбрать дополнительные инструменты для линтинга или форматирования:

| Инструмент | Назначение                                     |
| ---------- | ---------------------------------------------- |
| `rslint`   | Добавляет Rslint для линтинга.                 |
| `eslint`   | Добавляет ESLint для линтинга.                 |
| `prettier` | Добавляет Prettier для форматирования.         |
| `biome`    | Добавляет Biome для линтинга и форматирования. |

### Дополнительные навыки

Если вы планируете поддерживать сайт документации с помощью ИИ-агента, при создании проекта вы можете выбрать дополнительные **навыки**. CLI создаст директорию `.agents/skills` в вашем проекте и добавит туда выбранные навыки.

Для большинства сайтов документации мы рекомендуем выбрать:

- [rspress-docs-generator](https://github.com/rstackjs/agent-skills#rspress-docs-generator): помогает ИИ-агентам создавать и сопровождать сайты документации на Rspress, особенно если в монорепозитории документация вынесена в отдельный проект на Rspress.
- [rspress-best-practices](https://github.com/rstackjs/agent-skills#rspress-best-practices): предоставляет ИИ-агентам рекомендации по структуре проекта Rspress, конфигурации, MDX, темам и развёртыванию.
- [rspress-description-generator](https://github.com/rstackjs/agent-skills#rspress-description-generator): помогает ИИ-агентам писать и поддерживать описания страниц для SEO, поиска и ИИ-читаемых результатов.

Если вы выберете шаблон `basic-theme` или `i18n-theme`, по умолчанию будет выбран следующий навык:

- [rspress-custom-theme](https://github.com/rstackjs/agent-skills#rspress-custom-theme): позволяет вашему ИИ-агенту кастомизировать тему Rspress (CSS-переменные, слоты, переопределение компонентов темы).

Эти навыки не влияют на работу вашего сайта Rspress. Они предоставляют только локальные подсказки для ИИ-агентов при редактировании и поддержке проекта. Если вы не используете ИИ-агента, отмените выбор или нажмите Enter, чтобы пропустить этот шаг.

Подробнее о навыках агентов и других возможностях ИИ читайте в разделе [ИИ](/rspress-russian/guide/start/ai.md).

### Текущая директория \{#current-directory}

Чтобы создать проект в текущем каталоге, введите `.` в качестве пути к проекту, когда будет предложено:

```bash
◆  Create Rspress Project

◇  Project name or path
│  .
```

Если текущий каталог не пуст, CLI спросит, следует ли продолжить и перезаписать файлы.

### Неинтерактивный режим

Вы можете передать параметры CLI для создания проекта без интерактивных подсказок:

```bash
npx -y create-rspress@latest my-docs --template basic-theme --tools rslint,prettier
```

Вы также можете создать многоязычный шаблон:

```bash
npx -y create-rspress@latest my-docs --template i18n
```

Или создайте многоязычный сайт с папкой `theme`:

```bash
npx -y create-rspress@latest my-docs --template i18n-theme
```

Вы также можете явно добавить навыки агента:

```bash
npx -y create-rspress@latest my-docs --template basic-theme --skill rspress-docs-generator,rspress-best-practices,rspress-description-generator
```

Все флаги CLI, поддерживаемые `create-rspress`:

```bash
Usage: create-rspress [dir] [options]

Options:

  -h, --help                display help for command
  -d, --dir <dir>           create project in specified directory
  -t, --template <tpl>      specify the template to use
  --no-git                  skip Git repository initialization
  --tools <tool>            add additional tools, comma separated
  --skill <skill>           add optional skills, comma separated
  --override                override files in target directory
  --packageName <name>      specify the package name
  --template-version <ver>  specify the npm template version

Available templates:
  basic, basic-theme, i18n, i18n-theme

Optional tools:
  eslint, rslint, biome, prettier

Optional skills:
  rspress-docs-generator, rspress-best-practices, rspress-custom-theme, rspress-description-generator
```

## Ручная настройка

Если вы хотите добавить Rspress в существующий проект или самостоятельно создать минимальные файлы, начните с создания каталога:

```bash
mkdir rspress-app && cd rspress-app
```

Создайте `package.json`:

```bash
npm init -y
```

Установите Rspress:


```sh [npm]
npm install @rspress/core -D
```

```sh [yarn]
yarn add @rspress/core -D
```

```sh [pnpm]
pnpm add @rspress/core -D
```

```sh [bun]
bun add @rspress/core -D
```

```sh [deno]
deno add npm:@rspress/core -D
```

Создайте первую страницу:

```bash
mkdir docs && echo '# Привет, мир!' > docs/index.md
```

Добавьте (или обновите) секцию `scripts` в `package.json`:

```json
{
  "scripts": {
    "dev": "rspress dev",
    "build": "rspress build",
    "preview": "rspress preview"
  }
}
```

Создайте файл конфигурации:

```ts title="rspress.config.ts"
import { defineConfig } from '@rspress/core';

export default defineConfig({
  root: 'docs',
});
```

Создайте `tsconfig.json`:

```json
{
  "compilerOptions": {
    "lib": ["DOM", "ES2023"],
    "jsx": "react-jsx",
    "target": "ES2023",
    "noEmit": true,
    "skipLibCheck": true,
    "useDefineForClassFields": true,

    /* modules */
    "module": "ESNext",
    "moduleDetection": "force",
    "moduleResolution": "bundler",
    "verbatimModuleSyntax": true,
    "resolveJsonModule": true,
    "allowImportingTsExtensions": true,
    "noUncheckedSideEffectImports": true,
    "isolatedModules": true,

    /* type checking */
    "strict": true,
    "noUnusedLocals": true,
    "noUnusedParameters": true
  },
  "include": ["docs", "theme", "rspress.config.ts"],
  "mdx": {
    "checkMdx": true
  }
}
```

## Запуск dev-сервера \{#start-dev-server}

Запустите локальный сервер разработки следующей командой:


```sh [npm]
npm run dev
```

```sh [yarn]
yarn run dev
```

```sh [pnpm]
pnpm run dev
```

```sh [bun]
bun run dev
```

```sh [deno]
deno run npm:dev
```

:::tip

Для команды `dev` можно указать порт или хост сервера разработки с помощью параметров `--port` или `--host`, например: `rspress dev --port 8080 --host 0.0.0.0`.

:::

## Сборка для продакшена \{#build-for-production}

Соберите продакшен-версию сайта следующей командой:


```sh [npm]
npm run build
```

```sh [yarn]
yarn run build
```

```sh [pnpm]
pnpm run build
```

```sh [bun]
bun run build
```

```sh [deno]
deno run npm:build
```

По умолчанию Rspress использует папку `doc_build` как директорию вывода.

## Локальный предпросмотр \{#preview-locally}

Запустите локальный сервер предпросмотра следующей командой:


```sh [npm]
npm run preview
```

```sh [yarn]
yarn run preview
```

```sh [pnpm]
pnpm run preview
```

```sh [bun]
bun run preview
```

```sh [deno]
deno run npm:preview
```

Превью-сервер обслуживает скомпилированные файлы рабочей версии сайта из `doc_build`.

## Следующие шаги

- Изучите раздел [Базовые возможности](/rspress-russian/guide/basic/conventional-route.md), чтобы узнать о маршрутизации, главных страницах, статических ресурсах, развёртывании и других общих функциях сайта документации.
- Изучите раздел [Использование MDX](/rspress-russian/guide/use-mdx/components.md), чтобы узнать, как писать MDX и использовать компоненты в документации.
- Изучите раздел [Конфигурация](/rspress-russian/api/config/config-basic.md), чтобы узнать все поддерживаемые параметры конфигурации Rspress.
