Docusaurus 的多实例文档部署

  1. 目录结构
  2. 修改文件

要实现多实例文档部署其实非常简单,按照官方文档就可以操作。但是里面有一些坑需要回避。

有两种部署方式:

  1. doc文件夹内部再添加文件夹,这种方式可以控制版本。
  2. 在根目录下添加文件夹,这种方式不能控制版本。

本篇讲述第2种方式。第一种方式可以参考这篇文章

目录结构

docs/
- doc1.md
resources/
- doc2.md

如上加入了resources文件夹,里面包含了doc2.md文件。

修改文件

docusaurus.config.js文件中需要做出如下最小修改:

title="docusaurus.config.js"
module.exports = {
  plugins: [
    [
      '@docusaurus/plugin-content-docs',
      {
        id: 'resources',
        path: 'resources',
        routeBasePath: 'resources',
        sidebarPath: require.resolve('./sidebarsResources.js'),
        // ... 其他设置
      },
    ],
  ],
  themeConfig: {
    navbar: {
      items: [{
      {
        to: '/resources/doc2',   // 这里要指定具体的index文档
        activeBasePath: 'resources',
        label: '这里是文档2',
        position: 'left'
      },
      }]
    }
  }
};

最后是对sidebars的调整

title='./sidebarsResources.js'
module.exports = {
    resources: [{ type: 'autogenerated', dirName: '.' }],
}

转载请注明来源,欢迎对文章中的引用来源进行考证,欢迎指出任何有错误或不够清晰的表达。可以在下面评论区评论,也可以邮件至 365433079@qq.com