Writing rich content

authoring

The editor handles plain text well, but it also has a handful of richer primitives you may not have noticed. Everything here works in both changelog entries and guides.

Section headings (changelog)

At the top of a changelog entry, three chips let you insert ## New features, ## Enhancements, or ## Bug fixes. On the public page, these render as colored band headings - cyan for new features, lime for enhancements, coral for bug fixes - so readers can scan a long entry quickly.

Callouts

Block-level emphasis boxes. Four kinds:

Note. For neutral asides and supplementary context.

Tip. For "here's how to do this faster" advice.

Warning. For things that can break or surprise the reader.

Info. For pointers to docs, links, related content.

In the editor, type /note, /tip, /warning, or /info on a blank line, or use the toolbar.

Code blocks

Triple backticks (\`\`\`) in a paragraph or the toolbar code-block button opens a code block. You can set a language for syntax highlighting:

// A simple example
export async function ship(version: string) {
  await release(version);
  await notify();
}

Mermaid diagrams

Set the code-block language to mermaid and the public page will render it as a diagram. Useful for flows and system overviews.

flowchart LR
  A[Author entry] --> B{Has tag?}
  B -->|yes| C[Group on public page]
  B -->|no| D[Show inline]

Inline images

Drag an image into the editor or paste it from your clipboard. It uploads to our asset storage and inserts at the caret. Same for screenshots from Cmd+Ctrl+Shift+4 on macOS.

File attachments

Drag any file (PDF, zip, etc.) into the editor and it'll be inserted as a downloadable attachment block. Useful for release artifacts.

Collapsible toggles

From the toolbar, insert a Toggle to fold longer details under a clickable summary. Good for migration steps or "advanced configuration" you don't want at the top of the page.