Aller au contenu principal

Introduction au tutoriel

Découvrons Docusaurus en moins de 5 minutes.

Pour commencer

Commencez par créer un nouveau site.

Ou essayez Docusaurus immédiatement avec docusaurus.new.

Ce dont vous aurez besoin

  • Node.js version 18.0 ou supérieure :
    • Lors de l'installation de Node.js, il est recommandé de cocher toutes les cases liées aux dépendances.

Générer un nouveau site

Générez un nouveau site Docusaurus en utilisant le modèle classique.

Le modèle classique sera automatiquement ajouté à votre projet après avoir exécuté la commande :

npm init docusaurus@latest my-website classic

Vous pouvez taper cette commande dans l'invite de commande, Powershell, Terminal, ou tout autre terminal intégré de votre éditeur de code.

La commande installe également toutes les dépendances nécessaires pour exécuter Docusaurus.

Démarrer votre site

Exécutez le serveur de développement :

cd my-website
npm run start

La commande cd change le répertoire dans lequel vous travaillez. Pour travailler avec votre nouveau site Docusaurus, vous devrez naviguer dans le terminal jusqu'à cet emplacement.

La commande npm run start construit votre site localement et le sert via un serveur de développement, prêt à être consulté à l'adresse http://localhost:3000/.

Ouvrez docs/intro.md (cette page) et modifiez quelques lignes : le site se recharge automatiquement et affiche vos modifications.