Authoring guide

What renders, the building blocks for a great report, and the house style.

Recommended — for a polished report

Lead with a one-line summary, then a stat row of key numbers, a chart (bar or donut), and cards for highlights. Keep prose tight; let the components carry the data.

House style: no emoji. They render if included, but TPIT reports don't use them.

Theme

Pick four things in the sidebar when you create a report:

Template:: flow, dashboard
Color:: rose-violet, blue-cyan, emerald-teal, violet-indigo
Hero:: orbs, lines
Surface:: light, dark

Data-viz blocks

Fenced code blocks that render as colorful components. You supply the data; Brief draws it.

```statKPI figure row

Label: value
Rollout: 91%
Open risks: 0

```barBar chart

Jan: 10
Feb: 25
Mar: 40

```donutRing + center %

14/16
Rollout complete

```progressLabeled progress bars

Discovery: 100
Rollout: 66

```cardsHighlight cards (Title | body | icon)

Backups | verified weekly | check
Alerts | tuned | bolt

```timelineMilestones (state: done/active/planned)

Q1: done
Q2: active
Q3: planned

A bar immediately followed by a donut pair side-by-side. Icons (cards): check · alert · clock · shield · bolt · info.

Markdown supported

Headings (auto-numbered + TOC), bold/italic/strikethrough, inline & fenced code with syntax highlighting, tables, ordered/unordered/task lists, blockquotes (render as pull-quotes), links, images, kbd/mark, definition lists, footnotes, collapsible <details>, the five callouts (> [!NOTE] · TIP · WARNING · IMPORTANT · CAUTION), Mermaid diagrams (```mermaid), and KaTeX math ( $…$ / $$…$$).

Stripped for safety: scripts, iframes, event handlers, javascript: URLs, and author SVG. Secrets are scanned on publish.

Machine-readable version: GET /api/v1/capabilities.