Documentation
¶
Overview ¶
Command gen-site turns docs/ into the content tree the documentation site in website/ builds from, and keeps the README's install section in sync with docs/installation.md. Run it from anywhere inside the repository:
go run ./cmd/gen-site # write the site content and the README region go run ./cmd/gen-site -check # fail if the committed README region is stale
The site content is gitignored and rebuilt on every run; only README.md is a committed output.
Click to show internal directories.
Click to hide internal directories.