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

Quickstart

Render an existing flake

cd ~/my-nix-config
nix run github:kucendro/nixdiag

Prints the store path of the docs. Open wiki/book/index.html in it.

Start a new flake

nix flake init -t github:kucendro/nixdiag
nix build .#docs

First override

{
  nixdiag.units.nginx.role = "gateway";
  nixdiag.units.exporter.connections = [ { to = "grafana"; label = "metrics"; } ];
}

More in Topology.

Keep it honest in CI

checks.x86_64-linux.docs = self.packages.x86_64-linux.docs;

An unresolved connection fails nix flake check.