用途:在需要 Zig 语言参考、标准库 API 细节或函数签名时,通过命令行获取权威文档。
主要能力:
- 抓取标准库源码。推荐直接用 raw Codeberg 源,因其自带文档注释(//! 模块注释、/// 条目注释)。示例:curl -sL "https://codeberg.org/ziglang/zig/raw/branch/master/lib/std/<module>.zig",常见模块包括 log、mem、fs、heap、debug、testing。抓取分配器接口:curl -sL "https://codeberg.org/ziglang/zig/raw/branch/master/lib/std/mem/Allocator.zig"。
- 抓取语言参考。用 pandoc 转换:pandoc -f html -t plain "https://ziglang.org/documentation/master/",可管道给 head 分段查看。
- 列出标准库内容。通过 Codeberg API:curl -sL "https://codeberg.org/api/v1/repos/ziglang/zig/contents/lib/std" | jq -r '.[].name'。
- 抓取 zig.guide 内容:pandoc -f html -t plain "https://zig.guide/"。
- 版本特定文档。将 master 换成版本标签,如 curl -sL "https://codeberg.org/ziglang/zig/raw/tag/0.14.0/lib/std/log.zig",或 pandoc -f html -t plain "https://ziglang.org/documentation/0.14.0/"。
- 搜索。用 grep 在模块中查找函数,如 curl .../mem/Allocator.zig | grep -A10 "pub fn create"。
使用方式:通过 shell 命令调用 curl、pandoc、jq、grep 完成抓取与过滤。
限制:ziglang.org 的 std HTML 文档为 JavaScript 渲染,返回空内容,应避免使用;pandoc 失败时回退到 curl 加 raw Codeberg;注意 Codeberg API 限流,优先用 raw URL,并本地缓存常用内容。
适用场景:查询 Zig 标准库模块路径、API 签名、文档注释,或获取特定版本的语言参考。
其它信息(如安装步骤、收费)暂未提供。