Kitchen sink
Every element _prose.scss has an opinion about, in one place. If something looks wrong
in the theme, it should look wrong here first.
Headings
Third level
Fourth level
Hover any heading to reveal the permalink # in the gutter.
Text
A paragraph with bold, italic, both, strikethrough, inline code, and a
link to the introduction. Lorem ipsum dolor sit amet, consectetur adipiscing elit,
sed do eiusmod tempor incididunt ut labore et dolore magna aliqua — long enough to wrap at
the --content-max measure so the line length can be judged.
Keyboard keys
Esc closes the sidebar drawer. A chord nests: Ctrl + C
copies, ⌘ + C on a Mac — the outer kbd groups, so only
the inner keys get a cap.
Lists
- Unordered item
- Another item
- Nested item
- Nested sibling
- Third item
- Ordered item
- Second item
- Nested ordered
- Nested sibling
- Third item
Blockquote
A plain blockquote — muted text, left rule, no background.
Second paragraph inside the same quote.
Admonitions
Note
Blue, same as info. The default flavour.
Tip
Green. For the "you probably want this" aside.
Important
Yellow.
Warning
Orange. For things that break.
Caution
Red — reserved for destructive operations.
Code
TypeScript, to check the token colors:
interface Entry {
title: string
url: string
keywords?: string[]
}
// Filter the index by a lowercase query, cap the result list.
export function search(index: Entry[], query: string, limit = 8): Entry[] {
const q = query.trim().toLowerCase()
if (!q) return []
return index
.filter((e) => (e.title + ' ' + (e.keywords ?? []).join(' ')).toLowerCase().includes(q))
.slice(0, limit)
}
A very wide line, to check that the block scrolls instead of the page:
docker run --rm -it -v "$PWD":/app -w /app --env NODE_ENV=production node:22-alpine sh -c "npm ci --no-audit --no-fund && npm run build && npm test -- --runInBand"
Table
| Element | Selector | Note |
|---|---|---|
| Code block | .prose pre |
Wrapped in .code-wrap by the client script |
| Copy button | copy-elemental > button |
Injected, tooltip via data-tip, announced in a live region |
| Admonition | .marked-github-alert |
Color set per-flavour with --adm |
| Table | .prose table |
Scrolls on its own, zebra rows |
Image
Images are capped at the column width and get the theme radius.