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 !
{.docImage}
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.
La version minimale de Node.js supportée par Docusaurus est Node 8, mais des versions plus récentes fonctionneront également.
- Ouvrez votre Terminal.
- Si vous avez
brew
sur votre OS, exécutez la commande suivante pour installer Node (un runtime JavaScript qui vous permet d'exécuter JavaScript sur le serveur) etnpm
le gestionnaire de paquets (vous permet d'installer des modules npm depuis votre terminal).
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
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
- Allez sur https://github.com/ et créez un compte si vous n'en avez pas déjà un.
- Cliquez sur "Nouveau dépôt" ("New Repository") ou allez sur https://github.com/new.
- Nommez votre dépôt sans espaces. Par exemple,
docusaurus-tutorial
. - Procédez à la création du dépôt sans ajouter
.gitignore
ou une licence.
{.docImage}
- 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
cd
dans le dépôt que vous venez de créer.
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