to rfvtgbzxc

一些答疑。

针对项目

• https://github.com/rfvtgbzxc/RMMZ-TS-Vite

生成的文档是针对脚手架的还是插件的？

同时生成。两个都可以做。

其本质是 vuepress 配置文件，扫描项目的目录结构，然后生成对应的文档。所以生成的文档可以针对脚手架，也可以针对插件。

个人建议是先实现对手脚架的文档生成，再实现针对插件的文档生成。

可以自定义参考信息？

我不明白你指的参考信息是什么。

为什么文档也要放在 monorepo？

绝大多数项目都是这样做的。代码放在一侧，文档放在另一侧。

特别是自己写的文档，都是一起放在 monorepo 内的。

自动生成的 md 文件不参与 git 管理，不上传到仓库

不管我们使用的是 jsdoc 还是 typedoc，生成的文档都是 md 文件。基于代码文件生成的 md 文档，不参与管理。

生成文档的自动工作流？

这个随意。

• github workflow
• vercel
• gulp

对此我暂时没有好的实践方案。我还没有涉及到自动部署+发包+部署文档的内容。但是可以肯定的是，生成文档肯定是一个命令。这个命令可以和部署命令相结合。也可以用 gulp 统一配置上述的工作任务。

大概是这样的：

• jsdoc/typedoc 扫描文件生成 md
• vuepress2 扫描刚刚生成的 md，和已经写好的 md，共同生成出静态网页。存放在某个 dist 内。
• vite 手脚架扫描 rmmv/mz 模板。
• 手脚架编译 typescript 并部署到指定路径。

这样描述确实相当抽象，不够具体。我最好是给出一个小案例为好，不过我可能没空去弄这个。😂

本文迁移

本文最好是迁移到对应的 github issue 或者是 github discussions 内，而不是在我的笔记内写明。