1.13.0

Translate

Setting Up

Ce tutoriel s'adresse aux nouveaux utilisateurs qui veulent des instructions détaillées sur la façon de passer de zéro à un site Web Docusaurus avec des versions. C'est parti !

Docusaurus campfire {.docImage}

Installation de Git

Git est un système de contrôle de version pour suivre les changements dans le code source pendant le développement du logiciel et il peut vous aider à synchroniser les fichiers de version entre votre système local et votre dépôt en ligne. Git pour Windows inclut Git Bash, une application de terminal. Si ce n'est pas déjà installé, consultez Installation de Git.

Installation de Node.js

Node.js est un environnement qui peut exécuter du code JavaScript en dehors d'un navigateur web et est utilisé pour écrire et exécuter des applications JavaScript côté serveur. L'installation de Node.js inclut npm, le gestionnaire de paquets qui vous permet d'installer des modules NPM depuis votre terminal.

  1. Ouvrez le terminal sur un système Mac, Linux ou Unix. Ouvrez Git Bash sur un système Windows.
  2. Si vous avez brew sur votre OS, exécutez la commande suivante pour installer Node.
brew install node

Vous pouvez également télécharger un installateur depuis la page d'accueil Node.js.

Vérifification de votre installation de Node.js

Vérifiez que vous avez la version minimale requise installée en exécutant la commande suivante :

node -v

Vous devriez voir une version plus récente que Node 8.

node -v
v8.15.1

La version minimale de Node.js supportée par Docusaurus est Node 8, mais des versions plus récentes fonctionneront également.

Installation de Yarn (facultatif)

Nous vous recommandons fortement d'installer Yarn, un gestionnaire de paquets alternatif qui a de superbes performances pour gérer vos dépendances NPM. Découvrez le ici.

Vous pouvez continuer le tutoriel sans Yarn.

Création d'un dépôt GitHub et d'un clone local

  1. Allez sur https://github.com/ et créez un compte si vous n'en avez pas déjà un.
  2. Cliquez sur le bouton vert Nouveau (New) ou allez sur https://github.com/new.
  3. Tapez un nom de dépôt sans espaces. Par exemple, docusaurus-tutorial.
  4. Cliquez sur Créer un dépôt (Create repository) (sans .gitignore et sans licence).

GitHub create repo {.docImage}

  1. Dans Terminal ou Git Bash, cd dans un répertoire où le clone local sera un sous-répertoire.
cd /Users/NAME/doc_projects # Exemple macOS
# ou
cd /c/NAME/doc_projects # Exemple windows
  1. Clonez votre dépôt sur votre machine locale :
git clone [email protected]:USERNAME/docusaurus-tutorial.git # SSH
# ou
git clone https://github.com/USERNAME/docusaurus-tutorial.git # HTTPS

Installation de la commande init de Docusaurus

Docusaurus est livré avec un outil en ligne de commande pour vous aider à concevoir un site Docusaurus avec quelques exemples de modèles. Installons l'installateur !

Exécutez la commande suivante :

npm install --global docusaurus-init

ou si vous avez Yarn :

yarn global add docusaurus-init
Create a New Site →