Docusaurus多Docs实例侧边栏无法自动生成求助
解决Docusaurus多Docs实例侧边栏自动生成失败的问题
针对你遇到的No docs found in "../execution": can't auto-generate a sidebar错误,核心问题大概率是路径解析基准错误或者文档目录不符合要求,以下是具体排查和解决步骤:
1. 确认文档目录的有效性
- 检查
execution目录下是否存在.md格式的文档文件,且文件没有通过frontmatter的sidebar_position: false设置为隐藏,也没有被docusaurus.config.js中plugin配置的exclude规则排除。 - 确保
execution目录本身存在于项目根目录(对应你plugin配置里的path: './execution')。
2. 修正侧边栏配置的路径
Docusaurus中,autogenerated的dirName是相对于侧边栏配置文件自身所在目录解析的,不是项目根目录。举两个常见场景:
- 如果
sidebarsExecution.js和execution目录都在项目根目录:export default { executionSidebar: [ { type: 'autogenerated', dirName: './execution', // 直接指向同层级的execution目录 }, ], }; - 如果
sidebarsExecution.js放在src/目录下:export default { executionSidebar: [ { type: 'autogenerated', dirName: '../execution', // 向上跳出src目录,指向根目录的execution }, ], };
3. 清除缓存后重启项目
缓存可能导致路径解析异常,执行以下命令清除缓存后重新启动:
npm run clear npm run start
4. 调试路径解析(如果以上都无效)
启动项目时加上--debug参数,查看详细日志:
npm run start -- --debug
日志中会显示Docusaurus实际查找文档的路径,根据输出确认是否和你的预期一致,再针对性调整路径配置。
内容的提问来源于stack exchange,提问作者Christopher Marshall
相关产品推荐
相关产品推荐

