close

    Команды

    В этой главе вы узнаете о встроенных командах Rspress и о том, как их использовать.

    rspress dev

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

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

Опции:
   root                 указать корневую директорию проекта, по умолчанию — `docs` в текущей директории, необязательно
   -c --config <config> указать путь к файлу конфигурации, может быть относительным или абсолютным
   --port <port>        указать номер порта
   --host <host>        указать хост
   -h, --help           показать справку по команде

    rspress build

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

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

Опции:
   root                 указать корневую директорию проекта, по умолчанию — `docs` в текущей директории, необязательно
   -c --config <config> указать путь к файлу конфигурации, может быть относительным или абсолютным
   -h, --help           показать справку по команде

    rspress preview

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

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

Опции:
   root                 указать корневую директорию проекта, по умолчанию — `docs` в текущей директории, необязательно
   -c --config <config> указать путь к файлу конфигурации, может быть относительным или абсолютным
   --port <port>        указать номер порта
   --host <host>        указать хост
   -h, --help           показать справку по команде

    rspress eject

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

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

Аргументы:
   component             (опционально) компонент темы для извлечения; если опущен, будет выведен список всех доступных компонентов

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