docs: Document the tttk check command

Add check to the CLI guide, README, QWEN, and project structure: options, exit codes, diagnostic codes, and the checks not yet implemented. Mark compile as an unimplemented stub and fix stale element syntax in examples.
This commit is contained in:
2026-09-12 16:42:37 +08:00
parent 9def4d17aa
commit 9df6b9970a
4 changed files with 117 additions and 37 deletions
+3 -2
View File
@@ -4,7 +4,7 @@
具有以下功能:
- cli: 提供一个cli工具,用于将目录内的各种ttrpg文档编译为html。
- cli: 提供一个cli工具,用于预览和校验目录内的各种ttrpg文档。
- markdown:解析以各种格式编写的ttrpg内容,并支持扩展的语法。
- ttrpg组件:用于ttrpg内容的各种UI组件,且可以在markdown中通过扩展语法插入。
@@ -13,7 +13,8 @@
cli使用子命令组织:
- `serve`: 运行一个web服务器预览目录中的内容,并实时侦听更新。
- `compile`: 将目录中的内容输出为带hash路由、单个html入口的web应用。
- `check`: 静态校验目录中的 tttk 文档,输出结构化诊断(文件、行号、代码),存在错误时以退出码 1 结束。`--json` 输出机器可读结果。
- `compile`: [未实现] 存根命令,不会产生任何输出。
## 输入文件