Installation
Docusaurus se compose d'un ensemble de paquets npm.
Utilisez la Procédure accélérée pour comprendre Docusaurus 5 minutes Ⱡ!
Utilisez docusaurus.new pour tester immédiatement Docusaurus dans votre navigateur !
PrĂ©-requisâ
- Node.js version 18.0 ou supĂ©rieure (qui peut ĂȘtre vĂ©rifiĂ©e en exĂ©cutant
node -v
). Vous pouvez utiliser nvm pour gérer plusieurs versions de Node sur une seule machine installée.- Lors de l'installation de Node.js, il est recommandé de cocher toutes les cases liées aux dépendances.
Structurer un site web d'un projetâ
The easiest way to install Docusaurus is to use the create-docusaurus
command line tool that helps you scaffold a skeleton Docusaurus website. Vous pouvez exĂ©cuter cette commande n'importe oĂč dans un nouveau dĂ©pĂŽt vide ou dans un dĂ©pĂŽt existant, elle crĂ©era un nouveau rĂ©pertoire contenant les fichiers de structure.
npx create-docusaurus@latest my-website classic
Nous recommandons le template classic
pour que vous puissiez commencer rapidement et il contient des fonctionnalités disponibles dans Docusaurus 1. Le template classic
contient @docusaurus/preset-classic
qui inclut une documentation standard, un blog, des pages personnalisĂ©es et un framework CSS (avec support du mode sombre). Vous pouvez ĂȘtre opĂ©rationnel trĂšs rapidement avec le template classic et personnaliser les choses plus tard, lorsque vous serez plus familier avec Docusaurus.
Vous pouvez Ă©galement utiliser la variante TypeScript du template en passant l'option --typescript
. Consultez Support de TypeScript pour plus d'informations.
npx create-docusaurus@latest my-website classic --typescript
Si vous mettez en place un nouveau site web Docusaurus pour un projet Meta open source, exécutez cette commande à l'intérieur d'un dépÎt interne, qui est livré avec des valeurs par défaut utiles aux spécificités de Meta :
scarf static-docs-bootstrap
Commandes d'installation alternatives
Vous pouvez également initialiser un nouveau projet en utilisant votre gestionnaire de projet préféré :
- npm
- Yarn
- pnpm
- Bun
npm init docusaurus
yarn create docusaurus
pnpm create docusaurus
bunx create-docusaurus
Exécutez npx create-docusaurus@latest --help
, ou consulter ses docs de l'API pour plus informations Ă propos des options disponibles.
Structure du projetâ
En supposant que vous avez choisi le template classic et nommé votre site my-website
, vous verrez les fichiers suivants générés dans un nouveau répertoire my-website/
:
my-website
âââ blog
â âââ 2019-05-28-hola.md
â âââ 2019-05-29-hello-world.md
â âââ 2020-05-30-welcome.md
âââ docs
â âââ doc1.md
â âââ doc2.md
â âââ doc3.md
â âââ mdx.md
âââ src
â âââ css
â â âââ custom.css
â âââ pages
â âââ styles.module.css
â âââ index.js
âââ static
â âââ img
âââ docusaurus.config.js
âââ package.json
âââ README.md
âââ sidebars.js
âââ yarn.lock
RĂ©capitulatif de la structure du projetâ
/blog/
- Contient les fichiers Markdown du blog. Vous pouvez supprimer le répertoire si vous avez désactivé le plugin du blog, ou vous pouvez changer son nom aprÚs avoir défini l'optionpath
. Vous trouverez plus de détails dans le guide du blog/docs/
- Contient les fichiers Markdown pour la documentation. Personnalisez l'ordre de la barre latérale des docs danssidebars.js
. Vous pouvez supprimer le répertoire si vous avez désactivé le plugin des docs, ou vous pouvez changer son nom aprÚs avoir défini l'optionpath
. Vous trouverez plus de détails dans le guide des docs/src/
- Fichiers de non-documentation comme les pages ou les composants React personnalisĂ©s. Vous n'ĂȘtes pas obligĂ© de placer vos fichiers de non-documentation ici, mais les placer dans un rĂ©pertoire centralisĂ© permet de les spĂ©cifier plus facilement au cas oĂč vous auriez besoin de faire une sorte de vĂ©rification/traitement/src/pages
- Tous les fichiers JSX/TSX/MDX de ce répertoire seront convertis en page de site. Vous trouverez plus de détails dans le guide des pages
/static/
- Répertoire statique. Tout contenu à l'intérieur sera copié à la racine du répertoire final dubuild
/docusaurus.config.js
- Un fichier de configuration contenant la configuration du site. Ceci est l'Ă©quivalent desiteConfig.js
dans Docusaurus v1/package.json
- Un site Web Docusaurus est une application React. Vous pouvez y installer et utiliser tous les paquets npm que vous souhaitez/sidebars.js
- Utilisé par la documentation pour spécifier l'ordre des documents dans la barre latérale
Monoreposâ
Si vous utilisez Docusaurus pour la documentation d'un projet existant, un monorepo peut ĂȘtre la solution pour vous. Les monorepos vous permet de partager des dĂ©pendances entre des projets similaires. Par exemple, votre site web peut utiliser vos paquets locaux pour prĂ©senter les derniĂšres fonctionnalitĂ©s au lieu de dĂ©pendre d'une version publiĂ©e. Ensuite, vos contributeurs peuvent mettre Ă jour les documents au fur et Ă mesure qu'ils implĂ©mentent des fonctionnalitĂ©s. Un exemple de structure de dossier monorepo est ci-dessous :
my-monorepo
âââ package-a # Un autre paquet, votre projet actuel
â âââ src
â âââ package.json # Les dĂ©pendances du paquet A
âââ website # racine de Docusaurus
â âââ docs
â âââ src
â âââ package.json # Les dĂ©pendances de Docusaurus
âââ package.json # dĂ©pendances partagĂ©es du monorepo
Dans ce cas, vous devriez exécuter npx create-docusaurus
dans le dossier ./my-monorepo
.
Si vous utilisez un hébergeur comme Netlify ou Vercel, vous devrez changer le répertoire de base
du site Ă l'endroit oĂč se trouve votre racine Docusaurus. Dans ce cas, ce serait ./website
. Pour en savoir plus sur la configuration des commandes ignorées, consultez la documentation sur le déploiement.
En savoir plus sur les monorepos dans la documentation Yarn (Yarn n'est pas le seul moyen de mettre en place un monorepo, mais c'est une solution commune), ou vérifiez Docusaurus et Jest pour quelques exemples du monde réel.
ExĂ©cution du serveur de dĂ©veloppementâ
Pour prévisualiser vos modifications au fur et à mesure que vous modifiez les fichiers, vous pouvez lancer un serveur de développement local qui servira votre site Web et reflétera les derniÚres modifications.
- npm
- Yarn
- pnpm
- Bun
cd my-website
npm run start
cd my-website
yarn run start
cd my-website
pnpm run start
cd my-website
bun run start
Par dĂ©faut, une fenĂȘtre du navigateur s'ouvrira sur http://localhost:3000
.
Félicitations ! Vous venez de créer votre premier site Docusaurus ! Naviguez sur le site pour voir ce qui est disponible.
Constructionâ
Docusaurus est un gĂ©nĂ©rateur de site web statique moderne donc nous avons besoin de construire le site web dans un rĂ©pertoire de contenu statique et de le mettre sur un serveur web pour qu'il puisse ĂȘtre consultĂ©. Pour construire le site web :
- npm
- Yarn
- pnpm
- Bun
npm run build
yarn build
pnpm run build
bun run build
et le contenu sera généré dans le répertoire /build
, qui peut ĂȘtre copiĂ© dans n'importe quel service d'hĂ©bergement de fichiers statique comme GitHub pages, Vercel ou Netlify. Consultez la documentation sur le dĂ©ploiement pour plus de dĂ©tails.
Mise Ă jour de votre version Docusaurusâ
Il y a de nombreuses façons de mettre à jour votre version de Docusaurus. Une façon garantie est de changer manuellement le numéro de version dans package.json
à la version désirée. Notez que tous les paquets nommés @docusaurus/
doivent utiliser la mĂȘme version.
{
"dependencies": {
"@docusaurus/core": "3.7.0",
"@docusaurus/preset-classic": "3.7.0",
// ...
}
}
Ensuite, dans le répertoire contenant le fichier package.json
, exécutez la commande d'installation de votre gestionnaire de paquets :
- npm
- Yarn
- pnpm
- Bun
npm install
yarn install
pnpm install
bun install
npm install
may report several vulnerabilities and recommend running npm audit
to address them. Typically, these reported vulnerabilities, such as RegExp DOS vulnerabilities, are harmless and can be safely ignored. Also read this article, which reflects our thinking: npm audit: Broken by Design.
Pour vérifier que la mise à jour a été effectuée avec succÚs, exécutez :
npx docusaurus --version
Vous devriez voir la version correcte en résultat.
Alternativement, si vous utilisez Yarn, vous pouvez faire :
yarn add @docusaurus/core @docusaurus/preset-classic
Utilisez de nouvelles fonctionnalités inédites de Docusaurus avec @canary
npm dist tag
Des problĂšmes ?â
Ask for help on Stack Overflow, on our GitHub repository, our Discord server, or X.