Installation
Docusaurus se compose d'un ensemble de paquets de npm .
Utilisez la Procédure accélérée pour comprendre Docusaurus en 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
La façon la plus simple d'installer Docusaurus est d'utiliser l'outil en ligne de commande qui vous aide à créer un squelette de site web Docusaurus. 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
npm init docusaurus
yarn create docusaurus
pnpm create docusaurus
Exécutez npx create-docusaurus@latest --help
, ou consultez sa Documentation API pour plus d'informations sur tous les drapeaux 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