CLI Commands · Docusaurus

Docusaurus met à disposition un ensemble de scripts vous aidant dans la génération, le lancement et le déploiement de votre site web. Ces scripts peuvent être lancés avec la commande run lorsque vous utilisez Yarn ou npm. Quelques commandes habituelles sont :

yarn run start : génère et lance le site web via un serveur local
yarn run examples : crée les fichiers de configurations de l'exemple

Exécution depuis la ligne de command

Les scripts peuvent être exécutés en utilisant Yarn ou npm. Si vous avez déjà parcouru notre guide de démarrage, vous connaissez peut-être déjà la commande start. C'est la commande qui demande à Docusaurus d'exécuter le script docusaurus-start qui génère le site et démarre un serveur. et il est généralement appelé comme ça :

yarn run start

Le même script peut être lancé via npm :

npm run start

Pour lancer un script particulier, remplacez tout simplement la commande start dans l'exemple au dessus par la commande associée par votre script.

Utilisation avec des arguments

Certaines commandes possèdent des arguments qui sont optionnels. Par exemple, pour démarrer un serveur sur le port 8080, vous pouvez spécifier l'argument --port lors de l'exécution de start :

yarn run start --port 8080

Si vous lancez Docusaurus via npm, vous pouvez également utiliser les arguments des commandes en insérant -- entre npm run<command> et les arguments de la commande:

npm run start -- --port 8080

Configuration

Ces scripts sont mis en place sous la clé "scripts" dans votre fichier website/package.json dans le cadre du processus d’installation. Si vous avez besoin d'aide durant leur mise en place, merci de vous référer au guide d'installation.

Docusaurus met à votre disposition des mappings par défauts vous permettant de lancer les commandes en respectant les conventions de Node. A la place de taper docusaurus-start à chaque fois, vous pouvez taper yarn run start ou npm start pour arriver au même résultat.

Référence

`docusaurus-build`

Alias: build.

Options	Défault	Description
`--skip-image-compression`	`false`	Saute la compression de l'image. Généralement, vous ne voulez pas sauter cette étape à moins que vos images aient été déjà optimisés.
`--skip-next-release`	`false`	Ignore les prochains documents de version lorsque le versioning est activé. Cela ne construira pas les fichiers HTML pour les documents dans le répertoire `/docs` .

Génère le site Web statique, appliquant des traductions si nécessaire. Utile pour construire le site avant le déploiement.

Voir aussi docusaurus-start.

`docusaurus-examples`

Alias: examples

Arguments	Défault	Description
`<feature>`	-	Spécifier des caractéristiques `translations` ou `versions` pour générer des fichiers supplémentaires pour cette caractéristique.

Exemple

docusaurus-examples <feature>

Lorsqu'il n'y a pas de caractéristiques spécifiées, génère un petit site web d'exemple prêt à l'utilisation dans vos projets. Cette commande est expliquée en profondeur dans le guide de Préparation de votre site.

`docusaurus-publish`

Alias: publish-gh-pages

Builds, puis déploie le site web statique sur GitHub Pages. Cette commande est est destinée à être lancé durant l'étape de déploiement de CircleCI, et donc requiert d'avoir quelques variables d'environnement définit:

Ces variables d'environnements sont généralement définies manuellement par l'utilisateur dans le fichier de configuration CircleCI config.yml.

GIT_USER: L'utilisateur git qui doit être associé au commit de déploiement.
USE_SSH: Pour utiliser SSH au lieu d'HTTPS pour vous connecter au repo GitHub.

Exemple

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

Les variables d'environnement suivantes sont définies par CircleCI pendant le processus de compilation.

CIRCLE_BRANCH: La branche qui doit être associée au commit qui à démarré le processus CI.
CI_PULL_REQUEST: devrait être correcte si l’actuel tâche CI a été déclenché par un commit dans un pull request.

Vous devez définir les variables organizationName et projectName dans siteConfig.js. Si elles ne sont pas définies dans la configuration du site, les variables d'environnement de CircleCI seront utilisées.

CIRCLE_PROJECT_USERNAME: nom d’utilisateur GitHub ou de l’organisation qui héberge le repo Git, par exemple "facebook".
CIRCLE_PROJECT_REPONAME: le nom du repo Git, par exemple "Docusaurus".

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

`docusaurus-rename-version`

Alias: rename-version

Renames an existing version of the docs to a new version name.

Arguments	Défault	Description
`<currentVersion>`	-	Version à renommer.
`<newVersion>`	-	Version cible.

Exemple

docusaurus-rename-version <currentVersion> <newVersion>

Consultez le Guide de Versioning pour en savoir plus.

`docusaurus-start`

Alias: start.

This command will build the static website, apply translations if necessary, and then start a local server.

Options	Défault	Description
`--port <number>`	`3000`	Le site web est accessible par défaut sur le port 3000, mais si le port est déjà utilisé Docusaurus va essayer d'en trouver un de libre.
`--host <host>`	`localhost`	Spécifie un hôte à utiliser. Par exemple, si vous voulez que votre serveur soit accessible à l'extérieur, vous pouvez utiliser --host 0.0.0.0.0.
`--watch`	-	Regarde les fichiers et actualise la page lorsque des modifications ont été apporté. La valeur par défaut est true. Vous pouvez désactiver cette mécanique en utilisant `--no-cache`.

You can specify the browser application to be opened by setting the BROWSER environment variable before the command, e.g.:

$ BROWSER=firefox yarn start

`docusaurus-version <version>`

Alias: version

Génère une nouvelle version de la documentation. Cela va créer par une nouvelle copie de votre site, générée et stockée dans son propre répertoire versionné. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

Consultez le Guide de Versioning pour en savoir plus.

`docusaurus-write-translations`

Alias: write-translations

Écrit en anglais toutes les chaînes qui doivent être traduites dans un fichier website/i18n/en.json . The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.