SuperAPI AI 工具集

zig-docs

编程与开发

查看项目

更新于 10-15 19:55

技能介绍

用途:在需要查询 Zig API 细节、标准库函数签名或语言参考时,通过命令行抓取权威文档,避免打开不可靠或渲染失败的页面。

主要能力:优先获取 GitHub 原始源码(含 //! 模块文档与 /// 条目文档);用 pandoc 将 ziglang.org 语言参考与 zig.guide 转为纯文本;通过 GitHub API 列出标准库目录内容;支持按版本标签(如 0.14.0)获取对应文档;可用 grep 在源码中检索函数与文档注释。

使用方式:抓取标准库模块源码用 curl -sL "https://raw.githubusercontent.com/ziglang/zig/master/lib/std/<module>.zig";抓取语言参考用 pandoc -f html -t plain "https://ziglang.org/documentation/master/";列目录用 curl -sL "https://api.github.com/repos/ziglang/zig/contents/lib/std" | jq -r '.[].name'。常用模块含 log、mem、fs、heap、debug、testing,Allocator 位于 lib/std/mem/Allocator.zig。

适用场景:编写或调试 Zig 代码时快速核对标准库 API 与语言语义。

限制:ziglang.org 的标准库 HTML 文档为 JavaScript 渲染,会返回空内容,应改用原始源码;部分页面需 JavaScript,pandoc 失败时回退到 curl 加原始源码;GitHub API 有速率限制,建议直接用 raw.githubusercontent.com 或本地缓存。