Files

8.4 KiB
Raw Permalink Blame History

Style Guide

The single source of truth for colors, typography, and tokens. Every diagram draws from this — not from hex values inlined in other reference files. If you want to change the visual skin of Schematic, change this file.

Default skin is a cool editorial palette — white-smoke paper, jet-black ink, atomic-tangerine accent, blue-slate muted. It's designed to look good out of the box; swap these values (or run onboarding.md) and every new diagram inherits the new skin without touching any type-specific logic.

To generate your own from a website URL, see onboarding.md.


Tokens

Semantic roles

Every token is referred to by semantic role, not by its hex value. Type references (type-*.md) and SKILL.md say accent, not #f7591f.

Role Purpose Default (light) Default (dark)
paper Page background, default node fill #f5f5f5 (white-smoke) #2d3142 (jet-black)
paper-2 Diagram container bg, secondary fill #ececec #393e53
ink Primary text, primary stroke #2d3142 (jet-black) #f5f5f5 (white-smoke)
muted Secondary text, default arrow stroke #4f5d75 (blue-slate) #bfc0c0 (silver)
soft Sublabels, boundary labels #7a8399 #8e98ac
rule Hairline borders rgba(45,49,66,0.12) rgba(245,245,245,0.12)
rule-solid Stronger borders, baselines #bfc0c0 (silver) rgba(191,192,192,0.25)
accent Focal / 1–2 max per diagram #eb6c36 (atomic-tangerine) #f08a59
accent-tint Fill for accent-bordered boxes rgba(235,108,54,0.08) rgba(240,138,89,0.10)
link HTTP/API calls, external arrows #2e5aa8 #6a95d8

Brand palette source: this skin maps to a five-color brand palette — jet-black #2d3142, silver #bfc0c0, white-smoke #f5f5f5, atomic-tangerine #eb6c36, blue-slate #4f5d75. The soft, rule, and link tokens are derived (lighter slate, ink-at-opacity, and a saturated variant in the blue-slate hue family) to cover roles the brand palette doesn't name directly.

Note: The pre-baked example HTML files in assets/ were built under an earlier skin. Regenerating them against the current style-guide.md is a v5.1 task. New diagrams the skill produces will use the tokens above.

Inversion rule (light → dark)

Any rgba(28,25,23, X) in light becomes rgba(250,247,242, X) in dark. Same opacities, RGB flipped. The accent gets a slight hue-shift brighter to read on dark paper.

Series palette (multi-series chart types only)

A small set of desaturated, editorial-tone colors for chart types that genuinely need to distinguish multiple overlapping entities (currently: radar). The "1-focal" rule still holds — accent is reserved for the focal series; the palette below covers the rest.

Token Light Dark Notes
series-1 #7c8f6f (sage) #9caf8f Non-focal series
series-2 #5e7a9b (dusty-blue) #82a0c0 Non-focal series
series-3 #b8915a (mustard) #d3ad7a Non-focal series
series-4 #9c6b50 (rust-brown) #b88670 Non-focal series
series-5 #6e6479 (slate) #8d8298 Non-focal series

Fills sit at 0.18 opacity light, 0.22 dark; strokes use the full color. Don't backfill these tokens to non-chart types — architecture, swimlane, etc. continue to use muted-ink variants. The series palette is opt-in for diagrams where overlapping shapes demand distinguishable color, not a license to add color elsewhere.

Terminal skin (opt-in alternate)

A self-contained palette for the terminal-window primitive (see primitive-terminal.md) — a CLI-chrome register for dev-tool posts and technical social cards. It does not replace the default skin above and isn't affected by onboarding; it's a second, fixed skin you opt into per-diagram.

Token Hex Purpose
terminal-page #0a0a0a Page background behind the window
terminal-paper #141414 Window body, node fill
terminal-bar #1b1b1b Titlebar strip
terminal-border #2b2b2b Window border, hairlines
terminal-ink #f5f5f5 Primary text, primary stroke (same white-smoke as default ink)
terminal-muted #9a9a9a Secondary text, sublabels, ring stroke
terminal-soft #5c5c5c Tertiary — inactive dots, spokes
terminal-accent #ff5a36 The one accent — focal station, prompt sign, active dot
terminal-accent-tint rgba(255,90,54,0.12) Fill for accent-bordered boxes

1-accent rule still holds. Everything that isn't terminal-ink or terminal-muted/terminal-soft should be terminal-accent — never introduce a second hue.


Typography

Role Family Size Weight Usage
title Instrument Serif 1.75rem 400 Page H1
node-name Geist (sans) 12px 600 Human-readable labels
sublabel Geist Mono 9px 400 Port, protocol, URL, field type
eyebrow Geist Mono 7–8px 500, tracked 0.18em, uppercase Type tags, axis labels
arrow-label Geist Mono 8px 400, tracked 0.06em Arrow annotations
callout Instrument Serif italic 14px 400 Editorial asides only

Font stack

<link href="https://fonts.googleapis.com/css2?family=Instrument+Serif:ital@0;1&family=Geist:wght@400;500;600&family=Geist+Mono:wght@400;500;600&display=swap" rel="stylesheet">

Load-bearing rule: Mono is for technical content (ports, commands, URLs, field types). Names go in Geist sans. Page title is Instrument Serif. Italic Instrument Serif is reserved for annotation callouts (see primitive-annotation.md). Never JetBrains Mono as a blanket "dev" font.


Stroke, radius, spacing

Token Value Use
stroke-thin 0.8 Tag-box outlines, leaf nodes
stroke-default 1 Most strokes
stroke-strong 1.2 Emphasis strokes
radius-sm 4 Small tags
radius-md 6 Node boxes
radius-lg 8 Containers, rings
grid 4 Every coord, size, and gap is divisible by 4 (hard rule)

Node type → treatment

Semantic role combinations — reference these by name in type specs.

Type Fill Stroke
focal (1–2 max) accent-tint accent
backend #ffffff (white) ink
store ink @ 0.05 muted
external ink @ 0.03 ink @ 0.30
input muted @ 0.10 soft
optional ink @ 0.02 ink @ 0.20 dashed 4,3
security accent @ 0.05 accent @ 0.50 dashed 4,4

Customizing the skin

Three options:

  1. Run onboarding — see onboarding.md. Drop a URL; the skill extracts the palette + fonts and rewrites this file.
  2. Edit by hand — change the hex values in the tables above. Run the pre-output taste gate afterward to verify the accent still reads as "focal" against the new paper color.
  3. Brand handoff — paste your existing design-token JSON into a new section here and map its tokens to the semantic roles above.

Constraints (don't break these)

  • Contrast: ink must hit WCAG AA on paper. muted must hit AA on paper for 11px+ text.
  • One accent: pick one color for accent. Two accents erases the focal signal.
  • No rainbow palette: if your brand ships 8 colors, pick 3 (paper, ink, accent). The rest become muted variants.
  • Serif + sans + mono: three families, not more. If brand typography is all sans, keep Instrument Serif for title and callout anyway — the contrast is load-bearing.
  • Paper is warm-neutral, not pure white: pure white turns the design sterile. Pick a cream, bone, or light grey with a hint of warmth.
  • Dot pattern is optional, not default: the 22×22 dot pattern is an opt-in "dotted paper" variant (good for long-form editorial hero diagrams). The default background is a clean paper fill, no pattern. When the pattern is enabled, it should sit at ~10% opacity of ink on paper — visible but quiet.
  • Container is clean by default: the diagram sits directly on the page paper, no secondary container background or border. A framed variant (paper-2 bg + rule border + 8px radius + padding) is available as an opt-in for card-heavy layouts, but don't reach for it by default — the extra chrome fights the figure.