Команды
На этой странице представлены встроенные команды Rspress и их основные параметры.
Для команд dev, build и preview необязательный аргумент [root] задаёт корневой каталог документации. Если он не указан, Rspress использует значение root из файла конфигурации, а если root не настроен — каталог docs в текущей директории.
rspress dev
Команда rspress dev запускает локальный сервер разработки для предварительного просмотра и отладки документации.
rspress build
Команда rspress build собирает сайт документации для продакшена.
rspress preview
Команда rspress preview используется для локального предварительного просмотра файлов, полученных после выполнения команды rspress build.
rspress eject
Команда rspress eject копирует встроенный компонент темы в ваш проект, чтобы вы могли его кастомизировать.
Необязательный аргумент [component] задаёт компонент темы, который нужно извлечь. Если он не указан, Rspress выведет список всех компонентов, доступных для извлечения.
После выполнения извлечения файлы компонента помещаются в theme/components/<ComponentName>. Чтобы использовать вашу кастомизированную версию, реэкспортируйте компонент в theme/index.tsx.

