跳到主要内容

管理文档版本

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
module.exports = {
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