メインコンテンツまでスキップ

ドキュメントのバージョンを管理する

Docusaurusは、ドキュメントの複数のバージョンを管理できます。

ドキュメントのバージョンを作成する​

プロジェクトのバージョン1.0をリリースします：

npm run docusaurus docs:version 1.0

docs フォルダが versioned_docs/version-1.0 にコピーされ、 versions.json が作成されます。

ドキュメントに2つのバージョンができました：

  • 1.0 ( http://localhost:3000/docs/ ): バージョン1.0のドキュメント
  • current ( http://localhost:3000/docs/next/ ): 次回の、未リリースのドキュメント

バージョンドロップダウンを追加する​

バージョン間をシームレスに移動するために、バージョンドロップダウンを追加します。

docusaurus.config.js ファイルを変更します：

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

ナビバーにドキュメントバージョンのドロップダウンが表示されます：

ドキュメントバージョンドロップダウン

既存のバージョンを更新する​

それぞれのフォルダで、バージョン管理されたドキュメントを編集することができます：

  • versioned_docs/version-1.0/hello.md を更新すると http://localhost:3000/docs/hello が更新されます
  • docs/hello.md を更新すると http://localhost:3000/docs/next/hello が更新されます