gen-site

command
v0.11.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 10, 2026 License: MIT Imports: 5 Imported by: 0

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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL