Add a generated documentation site - #8
Merged
Merged
Conversation
scripts/build_site.py renders docs/WIKI.md into site/, split across ten pages. The Markdown stays the single source of truth; the HTML is committed because the deploy webhook copies site/ verbatim and cannot run a build step. The generator is Python 3 stdlib only and handles headings, paragraphs, fenced code with language labels, inline code, bold, italics, links, lists, tables, and blockquotes. Running it twice produces byte-identical output. site/style.css is azazel's stylesheet unchanged, plus a short block for the code language label, a scroll container for wide tables, and blockquote and rule styling. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
godofecht
added a commit
that referenced
this pull request
Jul 29, 2026
Add a generated documentation site
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Static docs site under
site/, matching the convention azazel already uses: the VPS webhook deploys any repo'ssite/directory verbatim to/var/www/<repo>/.10 pages generated from
docs/WIKI.mdbyscripts/build_site.py(python3 stdlib only). Markdown stays the single source of truth. Both the generator and its output are committed, because the webhook cannot run a build step.Verification
Well-formedness checked with a strict
html.parsersubclass that raises on stray end tags, mismatched closes, unclosed elements at EOF, and duplicate ids. Every page has a title and meta description. Code blocks round-trip byte for byte, including<,>and&.The generator asserts every source section lands on a page or is explicitly skipped, so the split cannot silently drop content when the Markdown changes.
site/style.cssis azazel's stylesheet unchanged for the first 9070 bytes, plus a marked additions block for table scroll containers and code-block language labels. azazel itself is untouched.🤖 Generated with Claude Code