[Github Action]PNPM monorepo docs package部署成Github Page

前言

最近需要把一个前端工程转交出去给其他小伙伴接手;
因为一直在内部孵化,基本除了少数维护的几个人可能知根知底;
而对于其他人来说一片空白,所以需要提供一个文档体系来辅助别人上手;

文档维护采用docusaurus来搭建,代码在Github,所以想把Github Page利用起来;
又因为采用monorepo子包的方式维护,看了下社区没有相关部署姿势,就写了这么一篇;

效果图

Github Action 执行过程

image.png

文档存放及部署分支

image.png

访问效果

image.png

工程信息

  • 依赖采用PNPM v8来统一管理
    • monorepo机制也是采用pnpm默认提供的
  • 文档不是在根目录(比如docs目录这种),是当做一个monorepo package来维护,如图

image.png

需要解决问题

因为我们把文档做成一个monorepo 子包来维护了,所以对应的产物也在包内;
常规的Github Page只能读取工程根目录或者根目录下的docs文件夹,此时就没法直接通用了,如下图所示;

  • 1
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

crper

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值