本仓库是 Lean 语言参考手册 的中文版本,当前迁移基线为 Lean 4.34.0-rc1,并随上游源码持续同步。手册面向需要精确查阅语言行为的读者;中文站点发布于 https://www.leanprover.cn/reference-manual/latest/。
- 先创建 issue,说明准备翻译或校对的章节,避免重复工作。
- fork
Lean-zh/reference-manual,从当前main创建分支。 - 遵循 贡献说明、术语表 与 AI 翻译规范。
- 提交前至少运行窄目标构建;涉及入口、导入或公共扩展时再运行完整构建。
翻译应保留上游最新章节、教程和构建结构,不应通过回退到旧版文件来覆盖上游更新。
安装 Elan 后,在仓库根目录运行:
lake update
lake build
./generate-html.sh --mode preview
python3 ./server.py -d _out/site 8880然后访问 http://localhost:8880。生成站点位于 _out/site/。
只检查中文 docstring 基础设施可运行:
lake build Manual.ZhDocString无需安装旧版 README 所述的 LaTeX 或 pdftocairo
依赖;当前上游构建流程不再生成这些旧图稿。
Lean 源码中的 {docstring ...}
直接读取英文文档。中文手册提供两个 Verso 块命令:
{zhdocstring 原声明 ZhDoc.中文文档载体}
{zhOptionDocs 选项名 ZhDoc.中文文档载体}
中文载体放在
Manual/ZhDocString/,保持与原声明一致的构造子/字段名称和顺序。zhdocstring
使用原声明的签名与链接,只替换说明文本;若结构不匹配会直接报错,避免把译文挂到错误字段或构造子上。新增模块必须导入
Manual/ZhDocString.lean,并由手册入口的 import DAG 覆盖。
main跟踪最新 Lean 正式版或候选版。- 上游 nightly/PR 兼容性 CI 保持原样,用于尽早发现 API 变化。
v*标签触发.github/workflows/release-tag.yml,构建后更新Lean-zh/reference-manual的deploy分支。
禁止在普通翻译 PR 中手工改写或删除上游 CI。发布工作流使用当前
deploy/prep.sh、deploy/build.sh、deploy/generate.sh 与
deploy/release.py 接口。
上游的详细开发与部署说明会持续变化。需要排查构建脚本或 nightly 机制时,请以当前仓库脚本及 英文上游 README 为准。