在 monorepo 里,README 经常分散在各个包下。预览一份 Markdown 时,我会先确认它自己的位置,再看链接是相对路径还是绝对路径。
例如 docs/README.md 写了 ./images/example.png,按文档位置解析时,会找 docs/images/example.png。若图在仓库根目录的 images 下,路径应写成 ../images/example.png。发布前可以从仓库根目录核对这两个文件是否已进入 Git,也可以直接用只含测试文件的小目录复现。
本地预览器还有资源边界。vsux 的预览把原始 HTML 当作文本显示,并限制远程资源及工作区外的本地资源。图片在仓库里但仍然不显示时,先核对打开的是哪个工作区,再判断资源是否明明在文档旁边,却落在当前工作区范围之外。
这是我维护的原生 macOS 开源终端工作区,相关实现和限制公开写在仓库里。查看 vsux 源码(GitHub)
文章根据作者分享的项目工作流整理,示例和措辞使用了 AI 辅助。
原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。
如有侵权,请联系 cloudcommunity@tencent.com 删除。