docs(site): Peekaboo-inspired docs at docs/site/#13
Merged
Conversation
Static docs site under docs/site/, generated by a small Python script (no Jekyll, no Astro, no node_modules). Inspired by peekaboo.sh — same shell (sidebar + content + right-rail TOC), same typography (Fraunces + Inter + JetBrains Mono), Optune palette (macOS system blue accent + deep purple secondary). Layout - docs/site/build.py — markdown -> HTML generator - docs/site/_template.html — shared shell - docs/site/_assets/style.css — full design system, light/dark themes - docs/site/_assets/site.js — theme toggle, copy buttons, TOC scroll-spy - docs/site/pages/*.md — 20 content pages - docs/site/dist/ — generator output (gitignored) Pages - Start: Overview, Install, Quickstart, Permissions & TCC - Features: Battery, Pointer & DPI, Wheel & SmartShift, Buttons, Hosts, Onboard, Keyboard, Per-app profiles - Reference: CLI, Architecture, Adding a device, Building, Troubleshooting, HID++ primer - About: Roadmap, Acknowledgements Deploy - .github/workflows/docs.yml runs build.py on every push to main and publishes docs/site/dist via GitHub Pages. No content screenshots yet — that's a follow-up pass.
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
docs/site/, generated by a small Python script (no Jekyll, no Astro, no node_modules). Inspired by peekaboo.sh — same shell (sidebar + content + right-rail TOC), same type pairing (Fraunces + Inter + JetBrains Mono), Optune palette (macOS system blue + deep purple secondary).What's in it
Layout
docs/site/build.py— Markdown → HTML, ~360 lines, stdlib onlydocs/site/_template.html— shared shelldocs/site/_assets/style.css— full design system, light + dark themesdocs/site/_assets/site.js— theme toggle, copy buttons, TOC scroll-spy, sidebar filterdocs/site/pages/*.md— 20 content pagesdocs/site/dist/— generator output (gitignored)Pages
Deploy
.github/workflows/docs.ymlrunsbuild.pyon every push tomainthat touchesdocs/site/**and publishesdocs/site/distvia GitHub Pages. After this PR merges, enable Pages in repo Settings → Pages → Source: GitHub Actions and the site will go live.Local preview
cd docs/site python3 build.py python3 -m http.server -d dist 8765 open http://localhost:8765Next
Screenshots — none in this PR per request. Follow-up pass once we have v0.7 UI captures.