Skip to main content

管理文档版本

Docusaurus 可以管理你的文档的多个版本。

创建文档版本​

为你的项目发布 1.0 版本文档：

npm run 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.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