Przeskocz do opisu głównego

Zarządzanie wersjami dokumentów

Docusaurus może zarządzać wieloma wersjami dokumentów.

Utwórz wersję dokumentów​

Opublikuj wersję 1.0 swojego projektu:

npm run docusaurus docs:version 1.0

Folder docs zostaje skopiowany do versioned_docs/version-1.0 i utworzony zostaje plik versions.json.

Twoje dokumenty mają teraz 2 wersje:

  • 1.0 pod adresem http://localhost:3000/docs/ dla dokumentacji wersji 1.0
  • current pod adresem http://localhost:3000/docs/next/ dla nadchodzącej, niewydanej dokumentacji

Dodaj rozwijaną listę wersji​

Aby płynnie poruszać się między wersjami, dodaj rozwijaną listę wersji.

Zmodyfikuj plik docusaurus.config.js:

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

Lista rozwijana wersji dokumentów pojawia się na pasku nawigacyjnym:

Lista rozwijana wersji dokumentów

Aktualizacja istniejącej wersji​

Można edytować wersjonowane dokumenty w ich odpowiednich folderach:

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