Contrast and readability in docs themes (WCAG AA in practice)
AA is 4.5:1 for body text and 3:1 for large text and interface parts. The two things that break it in almost every docs theme are the brand colour used as a link on white, and the same brand colour carried unchanged into dark mode. Check both schemes, or derive the palette so you cannot pick a failing one.
The numbers, and what they apply to
| What | Ratio at AA | Notes |
|---|---|---|
| Body text | 4.5:1 | Anything under 18.5px, or under 14px bold |
| Large text | 3:1 | 18.5px and up, or 14px and up if bold |
| Interface parts and graphics | 3:1 | Borders, icons, focus rings, form outlines |
| Disabled controls | Exempt | But nobody should have to read them |
| Logos | Exempt | Your wordmark is not held to this |
What breaks first in a docs theme
1. The brand colour as a link
2. The same colour in dark mode
3. Muted secondary text
4. Code blocks
5. Focus rings and borders
Deriving a palette instead of picking one
How to check your own theme in ten minutes
Questions
What contrast ratio does WCAG AA require?
Why does my brand colour fail as a link colour?
Does dark mode need separate contrast checks?
Is an automated contrast checker enough?
How does Docszero handle this?
Try the free plan instead of reading about it
- Drag in a folder of Markdown, a zip, a Word document or a PDF
- Search, navigation and a 404 page are built for you
- Export the built site or the source on every plan, free included
Mermaid diagrams in documentation, with examples
A diagram written as text lives in the same file as the words, reviews like a paragraph and never goes stale in a folder of PNGs. Five diagram types worth using, what each one is for, and when prose is the better answer.
Rollback for documentation, and why version history isn’t it
Version history restores a file. Rollback restores the site your readers are looking at. The difference matters at the exact moment you need it, which is usually ten minutes after a publish went out with something wrong in it.
Docszero vs GitBook: what you actually get for free
Both have a free plan. GitBook’s free tier is one user with no custom domain, and the first paid step is $65 per site a month plus $12 per user. Docszero is free for one site and $19.99 a month for ten, domain included.