Skip to main content

管理文档版本

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/
  • 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