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

🚩バージョン管理

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

バージョンの作成​

バージョン 1.0 をリリースします:

Terminal
bun docusaurus docs:version 1.0

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

これにより２つのバージョンのドキュメントがあります:

  • 1.0 は http://localhost:3000/docs/ を指し、バージョン 1.0 のドキュメントです
  • current は http://localhost:3000/docs/next/ を指し、次回のリリースされていないドキュメントです

バージョンドロップダウンの追加​

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

docusaurus.config.ts ファイルを編集します:

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

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

Docs Version Dropdown

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

バージョン付与したドキュメントを後から編集可能です:

  • versioned_docs/version-1.0/hello.md は http://localhost:3000/docs/hello を更新します
  • docs/hello.md は http://localhost:3000/docs/next/hello を更新します