根据包配置、源码及检查后的类型信息生成可离线阅读的文档网站。
包身份
所有者:豫言。包版本:0.1.0(本轮初始包版本,不代表编译器命令行版本)。
本包为可执行文件类型,不可被其他包依赖;包内模块仍可互相引用。类型典中的入口和文件名见包配置,程序产物为 yy文档网站生成器。
使用
在仓库根目录运行:
./yy豫构 检查 文档网站生成器
./yy豫构 构建 文档网站生成器
依赖、原生源文件及说明路径以 包配置 为准。构建不会自动运行程序;有发布或服务副作用的工具应先阅读其入口源码。
按包生成与发布
在仓库根目录运行,生成器从这里读取共用界面资源并发现包:
./yy文档网站生成器 构建包 库/包配置/包配置。包。豫 /tmp/发布材料/文档
# 外部包放在“外部包目录/所有者/包目录”下;最后一个参数可省略。
./yy文档网站生成器 构建包 /tmp/外部包/张三/例包/例包。包。豫 /tmp/例包发布/文档 /tmp/外部包
输出目录必须不存在或为空。生成器使用与豫构相同的配置解析器、所有者身份、直接依赖规则和包上下文;不会下载或安装依赖,缺失依赖会报错。按包枚举全部源码,排除嵌套包、符号链接、忽略目录及 。测试。豫。源码按路径排序;每个模块及所需依赖通过类型检查后,只为目标包的模块生成页面,不执行包代码。首页展示所有者、包名和版本,包说明页保留双语说明原文(按纯文本显示,不渲染 Markdown)。
包管理服务与生成器通过静态文件交接,没有远程生成 RPC:
- 本地生成
文档/index.html、模块页、包说明页及本地 CSS/JS。 - 发布者将整个
文档/连同源码/、构建/、必要的运行/放入同一个 ZIP,上传到POST /api/releases/zip。 - 服务静态解析包配置、检查必要材料并展开存储,不运行编译器,也不验证文档确由本工具生成。
- 门户通过
docsUrl在独立内容域的沙箱中展示文档。页面采用相对资源链接,兼容版本 URL 前缀;Cookie 和历史记录不可用时,语言切换仍能在当前页面生效。
生成器不创建 ZIP、不上传、不调用账户接口。包名、版本和说明以源码中的包配置为准,发布前应从同一份源码重新生成。当前输出仍依赖仓库中的界面资源,并非可脱离仓库安装的独立发行包。
官网兼容模式与验证
./yy文档网站生成器 构建 豫言编译器/入口。豫 dist/网站/文档 保留入口依赖闭包模式,官网发布流程继续使用它。此模式会展示依赖包模块,不适合作为单包发布文档。
./yy豫构 文件 工具/文档网站生成器/生成。测试。豫 --输出 yy文档生成测试
./yy文档生成测试
npm test --prefix 网站
回归测试覆盖完整包枚举、依赖隔离、包身份、双语说明、拒绝混入旧产物以及旧入口模式;网站测试覆盖内容沙箱禁止存储时的双语界面。
维护
修改接口时更新本说明;修改包身份、版本或构建组成时同步更新包配置。说明文件不参与模块导入。