用途:将 claat 形式的 Markdown 手顺书(如 manual.md)先做 lint 检查,通过后再生成 Google Codelabs 形式的 HTML。工具分两段:claat-tools 检查输入,通过后交给 PATH 上的 claat 生成 HTML。
前提:需确认 go version 与 claat version;若缺 claat,可安装验证过的版本:go install github.com/googlecodelabs/tools/claat@v0.0.0-20240220115335-873fe39d02dc
用法:CLI 从公开标签直接运行,工作目录不限,首次会拉取模块。先单独跑 lint,build 内部也会先 lint,但先单独 lint 可一次看完诊断减少往返: go run github.com/nogikun/claat/cmd/claat-tools@v0.1.0 lint path/to/manual.md go run github.com/nogikun/claat/cmd/claat-tools@v0.1.0 build -output output path/to/manual.md
退出码:0 成功;1 输入 lint 错误,改文档;2 环境问题(claat 不在 PATH、参数错误、文件不可读、非 UTF-8);其他为 claat 自身失败,读其标准错误。
诊断格式为 path:line:column: error CODE message。常见代码:META001 缺必填元数据;META002 未知或重复键(仅 7 键可用:summary id categories environments status feedback link analytics account);META003 值非法;DOC001 标题问题;STEP001 见标题层级问题;STEP002 Duration 缺失/位置/格式问题(须 H:M:SS);STEP003 正文为空;MD001 代码围栏未闭合;ASSET001 相对图片不存在。原则:不要为消除诊断而删内容,如图片应补齐而非删引用。
产物:build 成功后 claat 输出 ok<TAB><id>,生成 output/<id>/index.html 与 codelab.json;默认输出目录 output,可用 -output(-o)更改;已有文件不会被删除。生成后需确认 index.html 确实存在。本地预览可用 claat serve。
限制:资料未提供收费、价格、平台支持等信息。若需大量补写正文,应转为执笔工作,回到 claat-writer skill。未获委托不要提交或发布产物。