close

    Быстрый старт

    1. Инициализация проекта

    Способ 1: через CLI

    Создать проект Rspress можно одной командой с помощью create-rspress:

    npm
    yarn
    pnpm
    bun
    deno
    npm create rspress@latest

    Введите имя папки проекта — утилита сама создаст и настроит всё необходимое.

    Способ 2: вручную

    Сначала создайте пустую папку:

    mkdir rspress-app && cd rspress-app

    Выполните npm init -y, чтобы инициализировать проект. Установить Rspress можно через npm, pnpm, yarn или bun:

    npm
    yarn
    pnpm
    bun
    deno
    npm install @rspress/core -D

    Затем создайте файл index.md следующей командой:

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

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

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

    Затем создайте файл конфигурации rspress.config.ts:

    rspress.config.ts
    import { defineConfig } from '@rspress/core';

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

    Наконец, создайте tsconfig.json:

    {
  "compilerOptions": {
    "lib": ["DOM", "ES2020"],
    "jsx": "react-jsx",
    "target": "ES2020",
    "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
  }
}

    2. Запуск dev-сервера

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

    npm
    yarn
    pnpm
    bun
    deno
    npm run dev
    Совет

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

    3. Сборка для продакшена

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

    npm
    yarn
    pnpm
    bun
    deno
    npm run build

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

    4. Локальный предпросмотр

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

    npm
    yarn
    pnpm
    bun
    deno
    npm run preview