Skip to main content

综合

为什么选择使用 docusaurus 做为文档工具

因为对比了集中竞品,只有 docusaurus 可以直接按文件存放位置自动生成侧边菜单及导航,其他工具如 vuepress,python 的文档工具等,都需要手动维护一个侧边菜单文件,需要增加很多维护成本。虽然可以通过插件的方式实现自动侧边栏,但是社区没有成熟的插件,自己手动维护一个插件的话,需要不停跟随版本升级,比较麻烦。

缺点是,文档数量多了之后,编译打包速度非常慢,好在编译和部署已经全都配置好交给了 CI、CD 系统了。

参考