1.14.0

Translate

Installation

Docusaurus a été conçu dans l'optique d'être facilement installable et utilisable pour que votre site web soit rapidement opérationnel.

Installation de Docusaurus

Nous avons créé un simple script qui va vous installer l’ensemble de l’infrastructure :

  1. Assurez-vous d'avoir la dernière version de Node d'installé. Nous vous recommandons également d'installer Yarn.

    Vous devez avoir une version de Node >= 8.x et Yarn >= 1.5.

  2. Create a project, if none exists, and change your directory to this project's root.

    Vous pouvez créer la documentation dans ce dossier. The root directory may contain other files. The Docusaurus installation script will create two new directories: docs and website.

    Généralement, un projet GitHub existant ou nouvellement créé sera l'emplacement de votre site Docusaurus, mais ce n'est pas obligatoire pour utiliser Docusaurus.

  3. Exécutez le script d'installation de Docusaurus : npx docusaurus-init.

    Si vous n’avez pas node 8.2 + ou si vous préférez installer Docusaurus de manière globale, exécutez yarn global add docusaurus-init ou npm install - global docusaurus-init. Après, exécutez docusaurus-init.

Vérification de l'installation

Ainsi que les répertoires et les fichiers déjà existants, votre répertoire racine contient maintenant une structure semblable à :

root-directory
├── Dockerfile
├── README.md
├── docker-compose.yml
├── docs
│   ├── doc1.md
│   ├── doc2.md
│   ├── doc3.md
│   ├── exampledoc4.md
│   └── exampledoc5.md
└── website
    ├── blog
    │   ├── 2016-03-11-blog-post.md
    │   ├── 2017-04-10-blog-post-two.md
    │   ├── 2017-09-25-testing-rss.md
    │   ├── 2017-09-26-adding-rss.md
    │   └── 2017-10-24-new-version-1.0.0.md
    ├── core
    │   └── Footer.js
    ├── package.json
    ├── pages
    ├── sidebars.json
    ├── siteConfig.js
    └── static

Cette installation crée des fichiers Docker qui ne sont pas nécessaires pour exécuter docusaurus. Ils peuvent être supprimés sans problème dans un souci d'économie de place. Pour plus d'informations sur Docker, veuillez consulter la documentation Docker.

Exécution du site web d'exemple

Après avoir exécuté le script d'initialisation de Docusaurus, docusaurus-init comme décrit dans la section d'Installation, vous devriez avoir un exemple de site web à utiliser comme base. Pour se faire:

  1. cd website

  2. From within the website directory, run the local web server using yarn start or npm start.

  3. Load the example site at http://localhost:3000 if it did not already open automatically. Si le port 3000 est déjà pris, un autre port sera utilisé. Regardez les messages de la console pour voir lequel.

    Vous devrez voir le site d'exemple chargé dans votre navigateur. Il y a également un serveur de LiveReload de lancé et tous les changements effectuées sur la documentation et les fichés placés dans le dossier website causeront une actualisation de la page. Une couleur de thème primaire et secondaire générée aléatoirement sera choisie pour vous.

Lancement du serveur derrière un proxy

Si vous êtes derrière un proxy, vous devez le désactiver durant l'utilisation du serveur de développement. Ceci peut être fait en utilisant la variable d'environnement NO_PROXY.

SET NO_PROXY=localhost
yarn start (ou npm run start)

Mettre à jour votre version de Docusaurus

A tout moment, après avoir installé Docusaurus, vous pouvez vérifier votre version actuelle en allant dans le répertoire website et en écrivant yarn outdated docusaurus ou npm outdated docusaurus.

Vous pourrez voir quelque chose comme ça:

$ yarn outdated
Using globally installed version of Yarn
yarn outdated v1.5.1
warning package.json: No license field
warning No license field
info Color legend :
 "<red>"    : Major Update backward-incompatible updates
 "<yellow>" : Minor Update backward-compatible features
 "<green>"  : Patch Update backward-compatible bug fixes
Package    Current Wanted Latest Package Type    URL
docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/docusaurus#readme
✨  Done in 0.41s.

S'il n'y as pas de version visible sur la sortie de la commande outdated, vous êtes à jour.

Vous pouvez mettre à jour la dernière version de Docusaurus via:

yarn upgrade docusaurus --latest

ou

npm update docusaurus

Si vous obtenez une erreur après la mise à jours, essayez de nettoyer votre cache Babel (généralement il se trouve dans un dossier temporaire) ou de lancer le serveur Docusaurus (par exemple yarn start avec le paramètre d'environnement BABEL_DISABLE_CACHE=1.

Préparation du site →