Why Your GitHub README Diagrams Look Amateur (and the 4 Fixes That Take 10 Minutes)
Most README diagrams suffer from the same four defaults. Here's how to fix all of them in under ten minutes — without redrawing anything.
TL;DR If your README diagrams look like every other open-source repo's, that's because they all use the same four defaults. Switching to
theme: 'base'plus tuning four properties takes under ten minutes and produces a diagram that looks intentional. This is a follow-up to last week's SVG rendering deep-dive.
The four defaults that ruin your diagrams
- Pastel pink/blue palette — the
defaulttheme is from a 2014 Bootstrap-era moodboard. It signals "I copy-pasted from the docs." - Curved edges (
basis) — works for organic flows, terrible for technical diagrams. Lines that should be crisp end up wavy. - Default font — varies wildly by viewer. Looks fine in the GitHub editor preview, looks like Times New Roman in your CI artifact.
- Hardcoded background — light theme on a dark page, or vice versa. The diagram becomes a rectangle.
Each takes one config change to fix.
Fix 1: Switch to base theme
%%{init: {'theme':'base'}}%%
flowchart LR
A --> B --> Cbase is the only theme that exposes themeVariables for full control.
Fix 2: Set six theme variables
%%{init: {
'theme':'base',
'themeVariables': {
'primaryColor': '#1e293b',
'primaryTextColor': '#f8fafc',
'primaryBorderColor': '#475569',
'lineColor': '#94a3b8',
'fontFamily': 'system-ui, sans-serif',
'fontSize': '14px'
}
}}%%Six variables. That's the entire customization surface. Ignore the docs' fifty.
Fix 3: Linear edges
%%{init: {'flowchart': {'curve': 'linear'}}}%%For hierarchies, use step. For organic flows, keep basis. For everything else, linear.
Fix 4: Light/dark adaptive embed
<picture>
<source media="(prefers-color-scheme: dark)" srcset="./diagrams/auth-flow-dark.svg">
<img alt="Auth flow" src="./diagrams/auth-flow-light.svg">
</picture>GitHub READMEs respect prefers-color-scheme. Ship two SVGs and let GitHub pick.
Beauty Diagram outputs production-grade SVG with a CLI: one command, the right defaults baked in. (Disclosure: I work on it.)
Try the editor →Wrap-up
The README-diagram embarrassment problem is fixable in ten minutes. Most repos haven't done it because nobody told them where to look. Now you know.
Next week: how to embed Mermaid diagrams in Notion (the four working approaches in 2026).
Continue reading
Beautify Mermaid Diagrams in Obsidian and VS Code (Without Leaving Your Editor)
You write Mermaid in Obsidian or VS Code, but the default pastel preview keeps undermining the note you're polishing. Two plugins put a themed renderer in the same pane — no round-trip to a web tool.
Beautify Every Diagram in Your Markdown Docs with One Command
A docs repo has dozens of Mermaid blocks, half on the default pastel theme, some broken. Two commands plus a CI gate render them all to one consistent theme — and keep them that way.