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

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

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

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

npm run docusaurus docs:version 1.0

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

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

• 今後のリリース予定のドキュメントは(http://localhost:3000/docs/)のcurrentを参照してください

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

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

docusaurus.config.js ファイルを修正する。

docusaurus.config.js

export default {
  themeConfig: {
    navbar: {
      items: [
        {
          type: 'docsVersionDropdown',
        },
      ],
    },
  },
};

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

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

バージョン管理されたドキュメントは、それぞれのフォルダーで編集できます。

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