Golem Doc
Michael Bernstein zopemaven@gmail.com
v0.1.0a2
Golem is an extensible, Python-native static site generator and publishing workbench built for technical, interactive documentation using AsciiDoc as its primary source format.
The Workbench Philosophy
In folklore, a golem is an unadorned creature shaped from common earth and brought to life through the animating power of the inscribed word.
Golem approaches static publishing with a similar ethos:
- Unadorned & Heavy-Duty: A sturdy maple workbench with cast-iron vises. No fragile web framework graphs or opaque build magic.
- AsciiDoc Native: Moving beyond the semantic limitations of Markdown and the brittle syntax of reStructuredText into an industrial-strength document format.
- Pure HTML/CSS Baseline: Zero JavaScript required for default layouts, mode switching (
prefers-color-scheme), or navigation. - Fellow Craftsman Respect: Transparent ASTs, clean
pluggyhooks, and compiler-grade diagnostic coordinates (path:line:col) for every syntax issue.
Documentation Sections
Section | Description |
Installation instructions, environment setup, and your first compiled site in minutes. | |
Comprehensive reference for configuration schemas, AsciiDoc authoring, partial files, navigation auto-discovery, and dev server live-reloading. | |
Deep dive into Golem's AST/ASG compilation pipeline, Pluggy plugin hook specifications, Chameleon ZPT theme authoring, and recipes. | |
Full CLI command dictionary and embedded doctest verification reference. | |
Project origin, publishing philosophy, colophon design notes, and governance documents. |