Repository navigation
wenlab 1.0.0
wenlab 1.0.0
wenlab 提供中文写作规范和只读 Markdown 审计工具,检查文件名、排版、结构、拼写、术语和链接,并生成诊断报告与格式修复预览。内容与表达仍需按写作规范由人或 Agent 审阅。
下载文件
wenlab-1.0.0.zip:完整项目源码,包含隐藏配置目录、写作规范、审计脚本、测试和 Agent 技能。解压后得到wenlab-1.0.0/;不含 Git 历史、npm 依赖、原生工具和临时报告。wenlab-docs-audit-bin.zip:本地原始 Windows 工具包,包含 AutoCorrect 2.16.3、rumdl 0.3.0、Vale 3.24.0 和 lychee 0.24.2 四个.exe文件。wenlab-docs-audit-bin-licenses.zip:上述四个工具对应版本的上游许可证文本及项目第三方许可说明,请与工具包一并保留和分发。SHA256SUMS.txt:上述三个 ZIP 的 SHA-256 校验值。
GitHub 自动生成的 Source code 压缩包也可用于获取源码;原生工具需另外下载本页的工具包。
Windows 使用步骤
先准备 Node.js 22.18.0 或更高版本、Git 和 PowerShell。以下命令假设三个 ZIP 均已下载到当前目录,且解压目标目录尚不存在。
-
解压项目、工具及许可证:
Expand-Archive .\wenlab-1.0.0.zip -DestinationPath . Expand-Archive .\wenlab-docs-audit-bin.zip -DestinationPath .\wenlab-1.0.0\tools\docs-audit\bin Expand-Archive .\wenlab-docs-audit-bin-licenses.zip -DestinationPath .\wenlab-1.0.0\tools\docs-audit\bin\licenses Set-Location .\wenlab-1.0.0
工具 ZIP 内没有外层目录。解压后应直接存在
tools/docs-audit/bin/autocorrect.exe、lychee.exe、rumdl.exe和vale.exe。Gate 优先使用该目录中的工具,无需手动加入 PATH。 -
通过 Nexus 安装固定版本的 npm 依赖 CSpell 10.3.6 和 Prettier 3.9.9:
Set-Location .\tools\docs-audit npm ci --registry=https://nexus.home.arpa/repository/npm-group/ --ignore-scripts --include=dev Set-Location ..\..
此步骤需要能访问上述 Nexus 仓库。Nexus 不可访问或缺少制品时,记录包名、版本及错误后停止,不切换其他源。
-
检测依赖并执行本地检查:
node ./tools/docs-audit/Check-Dependencies.mjs node ./tools/docs-audit/LocalGate.mjs
依赖检测全部通过后再运行 Gate。默认检查本项目
docs/。检查其他项目,或在发布前检查外部网址,可分别运行:node ./tools/docs-audit/LocalGate.mjs -Path ../your-project node ./tools/docs-audit/RemoteGate.mjs -Path ../your-project
Gate 退出码:0 表示通过,1 表示文档质量问题,2 表示工具、配置或执行故障。报告位于 wenlab 根目录的 .tmp/docs-audit/,先查看当次报告的 diagnosis.md。检查不会修改原文。
项目专有词可写入被检查项目的 .wenlab/dictionary.txt;排除项及规则覆盖可写入 .wenlab/docs-audit.json。完整参数和配置说明见源码包中的 README.md、docs/依赖安装说明.md 和 docs/Markdown-审计入口.md。
工具 ZIP 仅包含 Windows 可执行文件;其他系统需自行预置相同版本的原生工具。Node.js、Git、npm 依赖和可选的 Beyond Compare 均不包含在工具 ZIP 中。
发布验证
发布源码对应 GitHub 提交 2a8f27dcec5eb5a71ec870d434b03346942730a6,其文件树与本地提交 6a64ab037b3179b1750021d82a1b4bef56f1a3a3 完全一致。
已通过依赖检测、LocalGate 和全部五组回归测试:编排契约、真实工具、审阅包、项目词典和项目配置。
项目原创代码与文档采用 MIT 协议;第三方工具保留各自许可证,详见源码中的 THIRD-PARTY-NOTICES 和随附许可证包。