Pular para o conteúdo principal

Gerenciar versões dos documentos

O Docusaurus pode gerenciar várias versões de seus documentos.

Criar uma versão de documentos​

Lance uma versão 1.0 do seu projeto:

npm run docusaurus docs:version 1.0

A pasta docs é copiada para versioned_docs/version-1.0 e o arquivo versions.json é criado.

Seus documentos agora têm 2 versões:

  • 1.0 em http://localhost:3000/docs/ para os documentos da versão 1.0
  • current em http://localhost:3000/docs/next/ para os próximos documentos, ainda não lançados

Adicionar um menu suspenso de versões​

Para navegar de forma transparente entre as versões, adicione um menu suspenso de versões.

Modifique o arquivo docusaurus.config.js:

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

O menu suspenso de versão dos documentos aparece em sua barra de navegação:

Menu suspenso de versão dos documentos

Atualizar uma versão existente​

É possível editar documentos versionados em suas respectivas pastas:

  • versioned_docs/version-1.0/hello.md atualiza http://localhost:3000/docs/hello
  • docs/hello.md atualiza http://localhost:3000/docs/next/hello