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

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

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

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

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

npm run docusaurus docs:version 1.0

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

これでドキュメントには2つのバージョンがあります：

  • 1.0: バージョン1.0のドキュメント用 http://localhost:3000/docs/
  • current: 今後の未リリースドキュメント用 http://localhost:3000/docs/next/

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

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

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

docusaurus.config.js
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 を更新します