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, and this page is available as Markdown at /rspress-russian/api/commands.md.
close

Команды

На этой странице представлены встроенные команды Rspress и их основные параметры.

Для команд dev, build и preview необязательный аргумент [root] задаёт корневой каталог документации. Если он не указан, Rspress использует значение root из файла конфигурации, а если root не настроен — каталог docs в текущей директории.

rspress dev

Команда rspress dev запускает локальный сервер разработки для предварительного просмотра и отладки документации.

Использование:
  $ rspress dev [root]

Опции:
  --port <port>          Указать порт сервера
  --host [host]          Указать хост, на котором будет слушать сервер
  --base <base>          Указать базовый путь и переопределить значение config.base
  -v, --version          Показать номер версии
  -h, --help             Показать это сообщение
  -c, --config <config>  Указать файл конфигурации (относительный или абсолютный путь)

rspress build

Команда rspress build собирает сайт документации для продакшена.

Использование:
  $ rspress build [root]

Опции:
  --base <base>          Указать базовый путь и переопределить значение config.base
  -h, --help             Показать это сообщение
  -c, --config <config>  Указать файл конфигурации (относительный или абсолютный путь)

rspress preview

Команда rspress preview используется для локального предварительного просмотра файлов, полученных после выполнения команды rspress build.

Использование:
  $ rspress preview [root]

Опции:
  --port <port>          Указать порт сервера
  --host [host]          Указать хост, на котором будет слушать сервер
  --base <base>          Указать базовый путь и переопределить значение config.base
  -h, --help             Показать это сообщение
  -c, --config <config>  Указать файл конфигурации (относительный или абсолютный путь)

rspress eject

Команда rspress eject копирует встроенный компонент темы в ваш проект, чтобы вы могли его кастомизировать.

Использование:
  $ rspress eject [component]

Опции:
  -h, --help             Показать это сообщение
  -c, --config <config>  Указать файл конфигурации (относительный или абсолютный путь)

Необязательный аргумент [component] задаёт компонент темы, который нужно извлечь. Если он не указан, Rspress выведет список всех компонентов, доступных для извлечения.

После выполнения извлечения файлы компонента помещаются в theme/components/<ComponentName>. Чтобы использовать вашу кастомизированную версию, реэкспортируйте компонент в theme/index.tsx.