Add Versions
Avec un site d'exemple déployé, nous pouvons maintenant essayer l'une des fonctionnalités mortelles de Docusaurus — la documentation versionnée. La documentation versionnée aide à afficher la documentation pertinente pour la version actuelle d'un outil et à masquer la documentation non publiée aux utilisateurs, ce qui réduit la confusion. La documentation pour les anciennes versions est également conservée et accessible aux utilisateurs des anciennes versions d'un outil, même lorsque la dernière documentation est modifiée.
{.docImage}
Libérer une version
Supposons que vous soyez satisfait de l'état actuel de la documentation et que vous vouliez la geler comme la documentation v1.0.0. Tout d'abord, vous cd dans le répertoire website et exécutez la commande suivante.
npm run examples versions
That command generates a versions.json file, which will be used to list down all the versions of docs in the project.
Ensuite, vous exécutez une commande avec la version que vous voulez créer, comme 1.0.0.
npm run version 1.0.0
Cette commande préserve une copie de tous les documents actuellement dans le répertoire docs et les rend disponibles en tant que documentation pour la version 1.0.0. Le répertoire docs est copié dans le répertoire website/versioned_docs/version-1.0.0.
Version actuelle
Tapez npm start et vous verrez la version à côté du titre. Version 1.0.0, qui est le numéro de votre version actuelle, apparaît à l'URL http://localhost:3000/docusaurus-tutorial/docs/doc1.
Testons comment le versionnage fonctionne réellement. Ouvrez docs/doc1.md et changez la première ligne du corps :
---
id: doc1
title: Latin-ish
sidebar_label: Page d'exemple
---
- Vérifiez la [documentation](https://docusaurus.io) pour savoir comment utiliser Docusaurus.
+ Ceci est la dernière version de la documentation.
## Lorem
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies.
Si vous allez sur http://localhost:3000/docusaurus-tutorial/docs/doc1 dans votre navigateur, vous vous rendez compte qu'il affiche toujours la ligne avant le changement. C'est parce que la version que vous regardez est la version 1.0.0, qui a déjà été figée dans le temps. Le document que vous avez modifié fait partie de la prochaine version.
Prochaine version
La dernière version des documents est consultable en ajoutant next à l'URL : http://localhost:3000/docusaurus-tutorial/docs/next/doc1. Maintenant vous pouvez voir le changement de ligne à "Ceci est la dernière version de la documentation." Notez que la version à côté du titre passe à "next" lorsque vous ouvrez cette URL.
Cliquez sur la version pour ouvrir la page des versions, qui a été créée à l'adresse http://localhost:3000/docusaurus-tutorial/versions avec une liste des versions de la documentation. Vous voyez que 1.0.0 et master y sont listées et qu'elles sont liées aux versions respectives de la documentation.
Les documents de master du répertoire docs sont devenus la version next lorsque le répertoire website/versioned_docs/version-1.0.0 a été créé pour la version 1.0.0.
Versions antérieures
Supposons que la documentation ait été modifiée et qu'elle ait besoin d'une mise à jour. Vous pouvez publier une autre version, comme la 1.0.1.
npm run version 1.0.1
La version 1.0.0 reste disponible en version antérieure. Vous pouvez le voir en ajoutant 1.0.0 à l'URL, http://localhost:3000/docusaurus-tutorial/docs/1.0.0/doc1. Un lien vers la version 1.0.0 apparaît également sur la page des versions.
Go ahead and publish your versioned site with the publish-gh-pages script!
Récapitulatif
C'est fini, Mesdames Messieurs ! Dans ce court tutoriel, vous avez pu constater à quel point il est facile de créer un site Web de documentation à partir de zéro et de créer des versions. Il y a bien d'autres choses que vous pouvez faire avec Docusaurus, comme ajouter un blog, rechercher et traduire. Check out the Guides section for more.