A command-line tool to view documentation for Zig standard library symbols.
zig build install -Doptimize=ReleaseFast --prefix $HOME/.localUsage: zigdoc [options] <symbol>
Show documentation for Zig standard library symbols and imported modules.
zigdoc can access any module imported in your build.zig file, making it easy
to view documentation for third-party dependencies alongside the standard library.
Examples:
zigdoc std.ArrayList
zigdoc std.mem.Allocator
zigdoc std.http.Server
zigdoc vaxis.Window
zigdoc zeit.timezone.Posix
Options:
-h, --help Show this help message
--dump-imports Dump module imports from build.zig as JSON
# Standard library symbols
zigdoc std.ArrayList
zigdoc std.mem.Allocator
zigdoc std.http.Server
# Imported modules from build.zig
zigdoc zeit.timezone.Posix- View documentation for any public symbol in the Zig standard library
- Access documentation for imported modules from your build.zig
- Shows symbol location, category, and signature
- Displays doc comments and members
- Follows aliases to implementation