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 aux utilisateurs pour la version actuelle de l'outil qu'ils utilisent et masque également la documentation non publiée aux utilisateurs, en réduisant la confusion. Les documentations pour les anciennes versions sont également conservées et accessibles aux utilisateurs des anciennes versions de l'outil même lorsque la dernière documentation est modifiée.
{.docImage}
Libérer une version
En supposant que nous sommes satisfaits de l'état actuel de la documentation et que nous voulons la geler comme la documentation v1.0.0. Nous exécutons d'abord la commande suivante pour générer un fichier versions.js , qui sera utilisé pour lister toutes les versions de documents du projet.
npm run examples versions # yarn examples versions
Ensuite, nous exécutons une commande avec la version que nous voulons créer, par exemple 1.0.0,
npm run version 1.0.0 # yarn version 1.0.0
Cela préservera tous les documents actuellement dans le répertoire docs et les rendra disponibles en tant que documentation pour la version 1.0.0.
Les documents dans le répertoire docs seront considérés comme faisant partie de la version suivante et sont disponibles, par exemple, à l'URL localhost:3000/<baseUrl>/docs/next/doc1. Les documents de la dernière version utilisent l'URL docs/doc1.
Testons comment le versionnage fonctionne réellement. On peut aller dans docs/doc1.md et changer 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 nous allons à l'URL localhost:3000/<baseUrl>/docs/doc1 dans notre navigateur, nous réalisons qu'elle montre toujours la ligne précédente. C'est parce que la version que nous regardons maintenant la version 1.0.0, qui a déjà été figée dans le temps.
Prochaine version
Les dernières versions de la documentation doivent être accessibles en ajoutant next à l'URL : localhost:3000/<baseUrl>/docs/next/doc1. Notez que la version à côté du titre change également à next lorsque nous sommes sur cette URL.
Une page de versions a été créée pour nous à l'adresse localhost:3000/<baseUrl>/versions qui affiche une liste des versions actuelles de la documentation. Vous voyez que 1.0.0 et master sont toutes les deux listées ici et qu'elles sont correctement liées aux versions respectives de la documentation.
Allez-y et publiez votre site versionné !
Récapitulatif
C'est fini, Mesdames Messieurs ! Dans ce court tutoriel, vous avez pu constater à quel point il était 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. Consultez la section Guides pour en savoir plus.