Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

CLI

nixdiag --facts facts.json --repo . --out docs

Renders from a facts.json that lib.mkFacts produced and never calls nix. This is what mkDocs runs in the sandbox; nix run github:kucendro/nixdiag builds it for the flake in the current directory.

FlagEffect
--facts FILEfacts, - reads stdin
--repo DIRthe documented repo, for the module tree and flake.lock
--out DIRoutput directory
--closures FILEthe closures.json that mkDocs { closures = true; } produces
--title "my wiki"book title, used when seeding book.toml
--extra-page Runbooks=./runbooks.mdcopy a hand-written page in and link it, repeatable
--extra-link Termux=termux.mdSUMMARY entry for a page another tool writes, repeatable
--no-svgwrite .d2 only, skip d2
--theme lightlight or dark, default dark; wiki diagrams carry both
--background "#ffffff"diagram canvas fill, default transparent
--color public=#ff5555palette override, repeatable, see styling

SVG rendering needs d2 on PATH; the packaged binary wraps it in.

nix run github:kucendro/nixdiag#audit

Checks the adapters against nixpkgs, see Topology.