CLI Commands · Docusaurus

Docusaurus предоставляет набор сценариев, которые помогут вам создавать, обслуживать и развертывать ваш веб-сайт. Эти сценарии могут быть вызваны с помощью команды run в Yarn или npm. Наиболее распространенные команды:

yarn run start: построить и запустить сайт на локальном сервере
yarn run examples: создать образец файлов конфигурации

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

Сценарии можно запустить с помощью Yarn или npm. Если вы уже прочитали руководство по началу работы, то вы уже должны быть знакомы с командой start. Эта команда указывает Docusaurus запустить сценарий docusaurus-start, который создаст сайт и запустит сервер, данную команду можно вызвать следующим образом:

yarn run start

Данный сценарий можно также запустить с помощью npm:

npm run start

Чтобы запустить отдельный сценарий, просто замените команду start в примере выше на команду, которая запускает ваш сценарий.

Параметры командной строки

Некоторые команды поддерживают необязательные параметры. Например, чтобы сервер использовал порт 8080, вы можете указать параметр --port во время запуска команды start:

yarn run start --port 8080

Если вы запускаете Docusaurus с помощью npm, вы также можете использовать параметры командной строки, вставив -- между npm run <command> и параметрами команды:

npm run start -- --port 8080

Настройка

Команды описаны в секции "scripts" файла website/package.json как часть процесса установки. Если требуется помощь в их настройке, обратитесь, пожалуйста, к руководству по установке.

Docusaurus по-умолчанию сопоставляет всем командам краткие псевдонимы, позволяя запускать их в соответствии с соглашениями Node. Вместо того, чтобы вводить docusaurus-start каждый раз, вы можете ввести yarn run start или npm run start чтобы достигнуть такого же результата.

Справка

`docusaurus-build`

Псевдоним: build.

Параметр	По-умолчанию	Описание
`--skip-image-compression`	`false`	Пропустить этап сжатия изображений. Вы можете указать этот параметр, если ваши изображения уже были оптимизированы и дополнительное сжатие не требуется.
`--skip-next-release`	`false`	Пропустить документы следующего релиза, если включено управление версиями. Это не приведет к созданию HTML-файлов для документов в каталоге `/docs`.

Создает статический веб-сайт, применяя перевод текста, если необходимо. Полезно для построения веб-сайта до развертывания.

Смотрите также docusaurus-start.

`docusaurus-examples`

Псевдоним: examples

Аргумент	По-умолчанию	Описание
`<feature>`	-	Укажите характеристику `translations` или `versions` для создания дополнительных файлов-примеров для неё.

Пример

docusaurus-examples <feature>

В случае, если характеристика не указана, будет создан образец веб-сайта с настройками по-умолчанию. Подробное описание данной команды можно найти в руководстве по настройке сайта.

`docusaurus-publish`

Псевдоним: publish-gh-pages

Строит, затем развертывает статический веб-сайт на GitHub Pages. Эта команда предназначена для запуска на этапе развертывания в CircleCI и, следовательно, ожидает определения нескольких переменных среды:

Переменные окружения, представленные ниже, обычно устанавливаются пользователем вручную в файле CircleCI config.yml.

GIT_USER: Пользователь git, к которому относится коммит развертывания.
USE_SSH: Нужно ли использовать SSH вместо HTTPS для вашего подключения к репозиторию GitHub.

Пример

GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages

Следующие переменные окружения устанавливаются в CircleCI во процессе сборки.

CIRCLE_BRANCH: Ветка git, в которой был сделан коммит, запустивший CI.
CI_PULL_REQUEST: Параметр равен true, если текущий запуск CI был осуществлен коммитом из pull-запроса.

Следующие переменные должны быть определены в siteConfig.js как organizationName и projectName, соответственно. Если они не определены в конфигурации вашего сайта, то будут использованы настройки из окружения CircleCI.

CIRCLE_PROJECT_USERNAME: Пользователь GitHub или наименование организации, предоставляющей репозиторий Git, например "facebook".
CIRCLE_PROJECT_REPONAME: Наименование репозитория Git, например "Docusaurus".

Вы можете узнать больше о настройке автоматического развертывания с помощью CircleCI в руководстве по публикации сайта.

`docusaurus-rename-version`

Псевдоним: rename-version

Изменяет наименование существующей версии на новое.

Аргумент	По-умолчанию	Описание
`<currentVersion>`	-	Версия, которая будет переименована.
`<newVersion>`	-	Версия, которая будет после переименования.

Пример

docusaurus-rename-version <currentVersion> <newVersion>

Обратитесь к руководству по версионированию, чтобы узнать больше.

`docusaurus-start`

Псевдоним: start.

Данная команда создает статический веб-сайт, применяет перевод текста при необходимости, затем запускает локальный сервер.

Параметр	По-умолчанию	Описание
`--port <number>`	`3000`	Веб-сайт по-умолчанию использует порт 3000, но если порт занят, то Docusaurus попробует найти доступный порт самостоятельно.
`--host <host>`	`localhost`	Укажите используемый хост. Например, если ваш сервер доступен снаружи, используйте --host 0.0.0.0.
`--watch`	-	Следует ли отслеживать файлы и перезагружать страницу при изменении файлов. Используется по-умолчанию. Отключить отслеживание можно с помощью параметра `--no-watch`.

Вы можете указать браузер, под которым откроется сайт после сборки, указав переменную окружения BROWSER перед вызовом команды, т.е.:

$ BROWSER=firefox yarn start

`docusaurus-version <version>`

Псевдоним: version

Создает новую версию документов. В результате будет создана новая копия вашего сайта и будет сохранена в отдельном каталоге с указанной версией. Данная команда полезна для создания снимков состояния документации API, отражающей особенности версий вашего ПО. В качестве номера версии можно указать любую строку.

Обратитесь к руководству по версионированию, чтобы узнать больше.

`docusaurus-write-translations`

Псевдоним: write-translations

Записывает английский для любых строк, которые должны быть переведены в файл website/i18n/ru.json. Сценарий пройдет по всем файлам в каталоге website/pages/en, использует файл siteConfig.js, а также другие файлы с настройками, чтобы получить строки на английском языке, которые затем будут переведены с помощью Crowdin. Обратитесь к руководству по переводу, чтобы узнать больше.