Aller au contenu principal
Version : 2.4.0

CLI

Docusaurus met à disposition un ensemble de scripts vous aidant dans la génération, le lancement et le déploiement de votre site web.

Une fois votre site Web démarré, la source du site Web contient les scripts Docusaurus que vous pouvez appeler avec votre gestionnaire de paquets :

package.json
{
// ...
"scripts": {
"docusaurus": "docusaurus",
"start": "docusaurus start",
"build": "docusaurus build",
"swizzle": "docusaurus swizzle",
"deploy": "docusaurus deploy",
"clear": "docusaurus clear",
"serve": "docusaurus serve",
"write-translations": "docusaurus write-translations",
"write-heading-ids": "docusaurus write-heading-ids"
}
}

Docusaurus CLI commands

Voici une liste des commandes CLI de Docusaurus et de leurs utilisations :

docusaurus start [siteDir]

Builds and serves a preview of your site locally with Webpack Dev Server.

Options

NomPar défautDescription
--port3000Spécifie le port du serveur dev.
--hostlocalhostSpécifie un hôte à utiliser. For example, if you want your server to be accessible externally, you can use --host 0.0.0.0.
--hot-onlyfalseActive le remplacement des modules à chaud sans rafraîchissement de page en cas d'échec de construction. More information here.
--no-openfalseN'ouvre pas automatiquement la page dans le navigateur.
--configundefinedPath to Docusaurus config file, default to [siteDir]/docusaurus.config.js
--poll [optionalIntervalMs]falseUtilisez l'interrogation des fichiers plutôt que la surveillance du rechargement en direct comme solution de rechange dans les environnements où la surveillance ne fonctionne pas. More information here.
--no-minifyfalseConstruit un site web sans minimiser les bundles JS/CSS.
important

Veuillez noter que certaines fonctionnalités (par exemple, les liens d'ancrage) ne fonctionneront pas en développement. La fonctionnalité marchera comme prévu en production.

Development over network

When forwarding port 3000 from a remote server or VM (e.g. GitHub Codespaces), you can run the dev server on 0.0.0.0 to make it listen on the local IP.

npm run start -- --host 0.0.0.0

Enabling HTTPS

Il y a plusieurs façons d'obtenir un certificat. We will use mkcert as an example.

  1. Run mkcert localhost to generate localhost.pem + localhost-key.pem

  2. Run mkcert -install to install the cert in your trust store, and restart your browser

  3. Lancez l'application avec les variables d'environnement HTTPS de Docusaurus :

HTTPS=true SSL_CRT_FILE=localhost.pem SSL_KEY_FILE=localhost-key.pem yarn start
  1. Open https://localhost:3000/

docusaurus build [siteDir]

Compile votre site pour la production.

Options

NomPar défautDescription
--bundle-analyzerfalseAnalyze your bundle with the webpack bundle analyzer.
--out-dirbuildLe chemin complet du nouveau répertoire de sortie, relatif à l'espace de travail actuel.
--configundefinedPath to Docusaurus config file, default to [siteDir]/docusaurus.config.js
--no-minifyfalseConstruit un site web sans minimiser les bundles JS/CSS.
info

For advanced minification of CSS bundle, we use the advanced cssnano preset (along with additional several PostCSS plugins) and level 2 optimization of clean-css. If as a result of this advanced CSS minification you find broken CSS, build your website with the environment variable USE_SIMPLE_CSS_MINIFIER=true to minify CSS with the default cssnano preset. Please fill out an issue if you experience CSS minification bugs.

You can skip the HTML minification with the environment variable SKIP_HTML_MINIFICATION=true.

docusaurus swizzle [themeName] [componentName] [siteDir]

Swizzle a theme component to customize it.

npm run swizzle [themeName] [componentName] [siteDir]

# Exemple (en omettant le siteDir pour indiquer ce répertoire)
npm run swizzle @docusaurus/theme-classic Footer -- --eject

The swizzle CLI is interactive and will guide you through the whole swizzle process.

Options

NomDescription
themeNameLe nom du thème à swizzler.
componentNameLe nom du composant du thème à swizzler.
--listAffiche les composants disponibles pour le swizzling
--ejectEject the theme component
--wrapWrap the theme component
--dangerAutorise le swizzling immédiatement sur des composants instables
--typescriptSwizzle le composant de type TypeScript
--configPath to docusaurus config file, default to [siteDir]/docusaurus.config.js
attention

Les composants non sécurisés présentent un risque plus élevé de rupture des modifications dues à des remaniements internes.

docusaurus deploy [siteDir]

Deploys your site with GitHub Pages. Check out the docs on deployment for more details.

Options

NomPar défautDescription
--out-dirbuildLe chemin complet du nouveau répertoire de sortie, relatif à l'espace de travail actuel.
--skip-buildfalseDéploie le site sans le construire. Cela peut être utile lorsque vous utilisez un script de déploiement personnalisé.
--configundefinedPath to Docusaurus config file, default to [siteDir]/docusaurus.config.js

docusaurus serve [siteDir]

Sert votre site web construit localement.

NomPar défautDescription
--port3000Utiliser le port spécifié
--dirbuildLe chemin complet du répertoire de sortie, par rapport à l'espace de travail courant
--buildfalseConstruire le site web avant de le servir
--configundefinedPath to Docusaurus config file, default to [siteDir]/docusaurus.config.js
--hostlocalhostSpécifie un hôte à utiliser. For example, if you want your server to be accessible externally, you can use --host 0.0.0.0.
--no-openfalse locally, true in CIN'ouvrez pas une fenêtre de navigateur à l'emplacement du serveur.

docusaurus clear [siteDir]

Vide les ressources générées par le site Docusaurus, les caches, les artefacts de construction.

Nous vous recommandons d'exécuter cette commande avant de signaler des bogues, après la mise à niveau des versions, ou à chaque fois que vous avez des problèmes avec votre site Docusaurus.

docusaurus write-translations [siteDir]

Écrit les fichiers de traduction JSON que vous devrez traduire.

By default, the files are written in website/i18n/<defaultLocale>/....

NomPar défautDescription
--locale<defaultLocale>Définissez le dossier de locale dans lequel vous voulez écrire les traductions des fichiers JSON
--overridefalseÉcrase les messages de traduction existants
--configundefinedPath to Docusaurus config file, default to [siteDir]/docusaurus.config.js
--messagePrefix''Permet d'ajouter un préfixe à chaque message de traduction, pour vous aider à mettre en évidence les chaînes non traduites

docusaurus write-heading-ids [siteDir] [files]

Add explicit heading IDs to the Markdown documents of your site.

NomPar défautDescription
filesTous les fichiers MD utilisés par les pluginsLes fichiers dans lesquels vous voulez que les ID d'entête soient écrits.
--maintain-casefalseConserve la casse des entêtes, sinon met tout en minuscules.
--overwritefalseÉcrase les ID d'entête existants.