zdocs is like zig std, but for all zig modules.
zdocs.mp4
show docs of std
zdocs -Mstdshow docs of specific module
zdocs -Mmarkdown=src/wasm/markdown.zigusage zdocs -h
Usage: zdocs [options]
Options:
-h, --help Print this help and exit.
-Mstd std Module.
-M<mod_name>=<src_path> Module name and module root source path.
--host <host> Host to listen on. Default is 127.0.0.1.
-p <port>, --port <port> Port to listen on. Default is 0, meaning an ephemeral port
chosen by the system.
--[no-]open-browser Force enabling or disabling opening a browser tab to the
served website. By default, enabled unless a port is specified.
# 1. get source code (clone or download)
# 2. install
zig build install -Doptimize=ReleaseSafe -p <your-install-prefix>
<your-install-prefix>is the directory where you want to install thezdocsbinary to, e.g.,
-p /usr/localwill install to/usr/local/bin/zdocsor
-p ~/.localwill install to~/.local/bin/zdocs.
zig build run -- -MstdNote:
zig build run -- -Mstduse hash(#) route- www use url path route
- also check www dist mode