Aller au contenu principal

Gérer les versions des documents

Docusaurus peut gérer plusieurs versions de vos documents.

Créer une version des documents​

Publiez la version 1.0 de votre projet :

npm run docusaurus docs:version 1.0

Le dossier docs est copié dans versioned_docs/version-1.0 et versions.json est créé.

Vos documents ont désormais deux versions :

  • 1.0 à l'adresse http://localhost:3000/docs/ pour les documents de la version 1.0
  • current à l'adresse http://localhost:3000/docs/next/ pour la prochaine documentation, non encore publiée

Ajouter un menu déroulant pour les versions​

Pour naviguer facilement entre les versions, ajoutez un menu déroulant.

Modifiez le fichier docusaurus.config.js :

docusaurus.config.js
export default {
  themeConfig: {
    navbar: {
      items: [
        {
          type: “docsVersionDropdown”,
        },
      ],
    },
  },
};

Le menu déroulant des versions de la documentation apparaît dans votre barre de navigation :

Menu déroulant des versions de la documentation

Mettre à jour une version existante​

Il est possible de modifier les documents versionnés dans leur dossier respectif :

  • versioned_docs/version-1.0/hello.md met à jour http://localhost:3000/docs/hello
  • docs/hello.md met à jour http://localhost:3000/docs/next/hello