豫言 / 文档网站生成器 @ 0.1.0

根据源码及类型信息生成文档网站。

源码浏览已生成;不能解析的文件以纯文本展示,不表示通过类型检查。

包说明.汉语.md

# 文档网站生成器

根据包配置、源码及检查后的类型信息生成可离线阅读的文档网站。

## 包身份

所有者:豫言。包版本:0.1.0(本轮初始包版本,不代表编译器命令行版本)。

本包为可执行文件类型,不可被其他包依赖;包内模块仍可互相引用。类型典中的入口和文件名见包配置,程序产物为 `yy文档网站生成器`。

## 使用

在仓库根目录运行:

```sh
./yy豫构 检查 文档网站生成器
./yy豫构 构建 文档网站生成器
```

依赖、原生源文件及说明路径以 [包配置](文档网站生成器。包。豫) 为准。构建不会自动运行程序;有发布或服务副作用的工具应先阅读其入口源码。

### 按包生成与发布

在仓库根目录运行,生成器从这里读取共用界面资源并发现包:

```sh
./yy文档网站生成器 构建包 库/包配置/包配置。包。豫 /tmp/发布材料/文档
# 外部包放在“外部包目录/所有者/包目录”下;最后一个参数可省略。
./yy文档网站生成器 构建包 /tmp/外部包/张三/例包/例包。包。豫 /tmp/例包发布/文档 /tmp/外部包
```

输出目录必须不存在或为空。生成器使用与豫构相同的配置解析器、所有者身份、直接依赖规则和包上下文;不会下载或安装依赖,缺失依赖会报错。按包枚举全部源码,排除嵌套包、符号链接、忽略目录及 `。测试。豫`。源码按路径排序;每个模块及所需依赖通过类型检查后,只为目标包的模块生成页面,不执行包代码。首页展示所有者、包名和版本,包说明页保留双语说明原文(按纯文本显示,不渲染 Markdown)。

包管理服务与生成器通过静态文件交接,没有远程生成 RPC:

1. 本地生成 `文档/index.html`、模块页、包说明页及本地 CSS/JS。
2. 发布者将整个 `文档/` 连同 `源码/`、`构建/`、必要的 `运行/` 放入同一个 ZIP,上传到 `POST /api/releases/zip`。
3. 服务静态解析包配置、检查必要材料并展开存储,不运行编译器,也不验证文档确由本工具生成。
4. 门户通过 `docsUrl` 在独立内容域的沙箱中展示文档。页面采用相对资源链接,兼容版本 URL 前缀;Cookie 和历史记录不可用时,语言切换仍能在当前页面生效。

生成器不创建 ZIP、不上传、不调用账户接口。包名、版本和说明以源码中的包配置为准,发布前应从同一份源码重新生成。当前输出仍依赖仓库中的界面资源,并非可脱离仓库安装的独立发行包。

### 官网兼容模式与验证

`./yy文档网站生成器 构建 豫言编译器/入口。豫 dist/网站/文档` 保留入口依赖闭包模式,官网发布流程继续使用它。此模式会展示依赖包模块,不适合作为单包发布文档。

```sh
./yy豫构 文件 工具/文档网站生成器/生成。测试。豫 --输出 yy文档生成测试
./yy文档生成测试
npm test --prefix 网站
```

回归测试覆盖完整包枚举、依赖隔离、包身份、双语说明、拒绝混入旧产物以及旧入口模式;网站测试覆盖内容沙箱禁止存储时的双语界面。

## 维护

修改接口时更新本说明;修改包身份、版本或构建组成时同步更新包配置。说明文件不参与模块导入。

包说明.文言.md

# 文档网站生成器

## 以包成文

于仓库根行 `./yy文档网站生成器 构建包 库/包配置/包配置。包。豫 /tmp/发布材料/文档`。外包另授末参,为外包总目录;其内以所有者分居。所出之目录须新或空,免旧篇杂入。

此器与豫构共用解籍、辨主、寻依及包上下文之法;不代取所依。遍录本包诸篇,除别包、链接、忽略目录及 `。测试。豫`,按径定序。先验诸篇及所依之类,而后惟书本包公名。首页载主、名、版;说明页并存汉语、文言原文,以纯文陈之,不解 Markdown。

包府不召此器。发布者先于本地成 `文档/index.html`、模块诸页、说明与界面资源,再合 `源码/`、`构建/`、必要之 `运行/` 为一 ZIP,送 `POST /api/releases/zip`。包府静解其籍,验所需材料而藏之,不编不行,亦不验其文果出此器。门户取 `docsUrl`,以别域沙箱示之。诸页之径皆相对;禁 Cookie 与历史记录,仍可于当页易辞。

此器不制 ZIP,不上传,不涉账户;发布前当据同源重生成。界面资源仍取仓库,尚非离库可装之发行包。

旧命 `构建 入口文件 【输出目录】` 仍循入口及所依,供官网之用,非单包之文。验之:先构建生成器,再行 `./yy豫构 文件 工具/文档网站生成器/生成。测试。豫 --输出 yy文档生成测试`、`./yy文档生成测试` 及 `npm test --prefix 网站`。所验为诸篇齐备、所依不杂、身份与双语说明、旧页不混、旧命可行及沙箱易辞。

根据源码及类型信息生成文档网站。

## 籍与用

所有者曰豫言,版本暂定 0.1.0。此包之版本,非编译器命令所报之版本。

此包不供他包所依,包内诸书仍可相引。程序名曰 `yy文档网站生成器`,入口依包籍所载。

在仓库之根行 `./yy豫构 检查 文档网站生成器` 以验其籍。行 `./yy豫构 构建 文档网站生成器` 以成其器,不自行之。

所依与原生组成皆见[包籍](文档网站生成器。包。豫)。变接口则修说明,变身份与组成则修包籍。说明不作模块。