docsgen

command
v4.8.0 Latest Latest
Warning

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

Go to latest
Published: May 6, 2026 License: MIT Imports: 11 Imported by: 0

Documentation

Overview

cmd/docsgen/main.go Generates the body and TOC inside docs/documentation.html from DOCUMENTATION.md.

The page chrome (head, nav, hero, search bar, sidebar, footer, inline CSS / JS) is hand-maintained in docs/documentation.html. This tool only rewrites the regions between the BEGIN_TOC/END_TOC and BEGIN_CONTENT/END_CONTENT markers, so the source of truth for documentation prose stays in DOCUMENTATION.md.

Usage:

go run ./cmd/docsgen                  # rewrite docs/documentation.html in place
go run ./cmd/docsgen -doc DOC.md -html docs/documentation.html

Jump to

Keyboard shortcuts

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