前言
最近需要把一个前端工程转交出去给其他小伙伴接手;
因为一直在内部孵化,基本除了少数维护的几个人可能知根知底;
而对于其他人来说一片空白,所以需要提供一个文档体系来辅助别人上手;
文档维护采用docusaurus来搭建,代码在Github,所以想把Github Page利用起来;
又因为采用monorepo子包的方式维护,看了下社区没有相关部署姿势,就写了这么一篇;
效果图
Github Action 执行过程
文档存放及部署分支
访问效果
工程信息
- 依赖采用PNPM v8来统一管理
- monorepo机制也是采用pnpm默认提供的
- 文档不是在根目录(比如docs目录这种),是当做一个monorepo package来维护,如图
需要解决问题
因为我们把文档做成一个monorepo 子包来维护了,所以对应的产物也在包内;
常规的Github Page只能读取工程根目录或者根目录下的docs文件夹,此时就没法直接通用了,如下图所示;