v0.1.0 A documentation theme for Static Site Generator
Documentation your readers can actually use
Lucid follows the U.S. Web Design System documentation-page pattern — side navigation, in-page contents, and a reading column that stays honest at 66 characters. Every colour pair is checked at WCAG AAA before the site builds.
Get started Read the accessibility notes
Build it in one command
Lucid is a directory of Markdown and templates. There is no build step of its own, no bundler and no client-side framework to install.
terminal
ssg --config themes/lucid/ssg.toml
content 8 pages, 2 locales
output public/lucid
audit 0 findingsWhat it gives you
The layout decisions are the ones the U.S. Web Design System recommends for documentation, and they are the ones readers expect from every serious docs site.
Side navigation
A persistent list of the pages in the section, with the current page marked by aria-current rather than colour alone.
In-page contents
The headings of the page you are reading, so a long reference is navigable without scrolling to find its shape.
Prev and next
Documentation is read in order at least once. Pagination names the neighbouring page rather than pointing an arrow at it.
Two colour schemes
Light and dark, both at AAA. Without JavaScript the theme follows the operating system; the control cycles back to that setting.
Accessibility that is measured, not asserted
Claims about accessibility are cheap. These are enforced by the repository's own gates, so a change that breaks one fails the build.
- 7:1
- Minimum contrast on every text token pair, in both colour schemes — WCAG 1.4.6 Contrast Enhanced, the AAA threshold.
- 44px
- Minimum size for every interactive target, meeting WCAG 2.5.5 Target Size at AAA rather than the 24px AA minimum.
- 0 KB
- JavaScript required to read the documentation. The scripts add a colour-scheme control and a mobile menu, and nothing else.