Aller au contenu principal

Gérer les versions de la documentation

Docusaurus peut gérer plusieurs versions de votre documentation.

Créer une version de la documentation​

Publiez une 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éé.

Votre documentation comporte désormais 2 versions :

  • 1.0 sur http://localhost:3000/docs/ pour la documentation de la version 1.0
  • current sur http://localhost:3000/docs/next/ pour la documentation à venir, non publiée

Ajouter une liste déroulante de versions​

Pour naviguer de manière fluide entre les versions, ajoutez une liste déroulante de versions.

Modifiez le fichier docusaurus.config.js :

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

La liste déroulante des versions de la documentation apparaît dans votre barre de navigation :

Liste déroulante 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