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 :
{
// ...
"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
Nom | Par défaut | Description |
---|---|---|
--port | 3000 | Spécifie le port du serveur dev. |
--host | localhost | Spé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-only | false | Active le remplacement des modules à chaud sans rafraîchissement de page en cas d'échec de construction. More information here. |
--no-open | false | N'ouvre pas automatiquement la page dans le navigateur. |
--config | undefined | Path to Docusaurus config file, default to [siteDir]/docusaurus.config.js |
--poll [optionalIntervalMs] | false | Utilisez 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-minify | false | Construit un site web sans minimiser les bundles JS/CSS. |
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.
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
- Yarn
- pnpm
npm run start -- --host 0.0.0.0
yarn run start --host 0.0.0.0
pnpm 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.
-
Run
mkcert localhost
to generatelocalhost.pem
+localhost-key.pem
-
Run
mkcert -install
to install the cert in your trust store, and restart your browser -
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
- Open
https://localhost:3000/
docusaurus build [siteDir]
Compile votre site pour la production.
Options
Nom | Par défaut | Description |
---|---|---|
--bundle-analyzer | false | Analyze your bundle with the webpack bundle analyzer. |
--out-dir | build | Le chemin complet du nouveau répertoire de sortie, relatif à l'espace de travail actuel. |
--config | undefined | Path to Docusaurus config file, default to [siteDir]/docusaurus.config.js |
--no-minify | false | Construit un site web sans minimiser les bundles JS/CSS. |
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
- Yarn
- pnpm
npm run swizzle [themeName] [componentName] [siteDir]
# Exemple (en omettant le siteDir pour indiquer ce répertoire)
npm run swizzle @docusaurus/theme-classic Footer -- --eject
yarn swizzle [themeName] [componentName] [siteDir]
# Exemple (en omettant le siteDir pour indiquer ce répertoire)
yarn swizzle @docusaurus/theme-classic Footer --eject
pnpm run swizzle [themeName] [componentName] [siteDir]
# Exemple (en omettant le siteDir pour indiquer ce répertoire)
pnpm run swizzle @docusaurus/theme-classic Footer -- --eject
The swizzle CLI is interactive and will guide you through the whole swizzle process.
Options
Nom | Description |
---|---|
themeName | Le nom du thème à swizzler. |
componentName | Le nom du composant du thème à swizzler. |
--list | Affiche les composants disponibles pour le swizzling |
--eject | Eject the theme component |
--wrap | Wrap the theme component |
--danger | Autorise le swizzling immédiatement sur des composants instables |
--typescript | Swizzle le composant de type TypeScript |
--config | Path to docusaurus config file, default to [siteDir]/docusaurus.config.js |
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
Nom | Par défaut | Description |
---|---|---|
--out-dir | build | Le chemin complet du nouveau répertoire de sortie, relatif à l'espace de travail actuel. |
--skip-build | false | Déploie le site sans le construire. Cela peut être utile lorsque vous utilisez un script de déploiement personnalisé. |
--config | undefined | Path to Docusaurus config file, default to [siteDir]/docusaurus.config.js |
docusaurus serve [siteDir]
Sert votre site web construit localement.
Nom | Par défaut | Description |
---|---|---|
--port | 3000 | Utiliser le port spécifié |
--dir | build | Le chemin complet du répertoire de sortie, par rapport à l'espace de travail courant |
--build | false | Construire le site web avant de le servir |
--config | undefined | Path to Docusaurus config file, default to [siteDir]/docusaurus.config.js |
--host | localhost | Spé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-open | false locally, true in CI | N'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>/...
.
Nom | Par défaut | Description |
---|---|---|
--locale | <defaultLocale> | Définissez le dossier de locale dans lequel vous voulez écrire les traductions des fichiers JSON |
--override | false | Écrase les messages de traduction existants |
--config | undefined | Path 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.
Nom | Par défaut | Description |
---|---|---|
files | Tous les fichiers MD utilisés par les plugins | Les fichiers dans lesquels vous voulez que les ID d'entête soient écrits. |
--maintain-case | false | Conserve la casse des entêtes, sinon met tout en minuscules. |
--overwrite | false | Écrase les ID d'entête existants. |