diff --git a/GRAPHICS.md b/GRAPHICS.md new file mode 100644 index 000000000..19b2134b8 --- /dev/null +++ b/GRAPHICS.md @@ -0,0 +1,84 @@ +# Graphics — an inline-rendering guide for GitHub + +companion to `HAND.md` and `papers/VOICE.md`. HAND governs how the code reads, VOICE how the papers sound; this governs how a **PR, issue, or repo `.md` draws** — pictures that render on github.com from text alone. + +it exists because the reflex is to drag in a screenshot. a screenshot drifts the moment the code moves and can't be reviewed as a diff. a diagram written *in text*, beside the change, can't drift — it versions with the thing it explains. so: prefer the mark you can type. + +## the one rule + +**if it isn't a fence or `$math$`, it doesn't render.** github runs every markdown surface through a sanitizer. know the line and you stop guessing. + +## what renders inline — verified on github.com + +- **`​```mermaid`** — diagrams *and* charts. flow, sequence, state, er, class — and `pie`, `xychart-beta`, `sankey-beta`, `quadrantChart` for data. `classDef` colors nodes (the ac chartreuse-on-black look stays in text). +- **`$…$` / `​```math`** — equations. `\color{…}{…}` and `\bbox[bg]{…}` tint *real content*. that's the whole of what math draws — see the dead end below. +- **`​```geojson` / `​```topojson`** — an interactive leaflet map. +- **braille / block art in a plain `​```` ` fence** — the only way to draw *arbitrary* art inline. low-res, but anything. +- **prose primitives** — tables, task lists, `
`, `> [!NOTE]` alerts, footnotes. + +## what does not render — and why + +| you reach for | what happens | because | +|---|---|---| +| inline `…` | stripped | sanitizer | +| `data:` uri in `` | stripped | sanitizer | +| `