Skip to content

Callouts

Callouts draw attention to important information in your documents and e-mails.

AI-assisted, human-approvednovem uses AI to review and keep our documentation up to date.

Available in: documents and e-mails.

{{ callout type: warn, title: "Incomplete data", border: true }}
The September figures exclude two late submissions. Totals will be
updated when those submissions have been processed.
{{ /callout }}

The warn type selects the warning style. title adds a label above the body, and border: true draws a border around the callout. Close the block with {{ /callout }} on its own line.

Overview

Callouts provide a way to draw attention to important information. They come in four visual styles — info, warning, danger and success — and work the same way in documents and e-mails.

A callout is a container block; its body supports simple novem markdown.

Options

Options are written inside the double braces, inline or as YAML on several lines.

Type

keyword: type
options: info | warn | danger | success
aliases: warning → warn, error / err / alert → danger, succ → success
default: info

The type determines the visual style and color of the callout box. Use info for general information, warn for important notices, danger (or its synonym error) for critical alerts, and success for positive confirmations. The aliases are accepted everywhere, so danger and error render identically in both documents and e-mails.

Border

keyword: border
options: true | false
default: false

Controls whether a visible border is rendered around the callout box.

Title

keyword: title
options: "Description text"

An optional short prefix or description that appears above the callout content in a smaller, muted style.

Examples

A simple notice

{{ callout
  type: info
}}
Please note that data for January 18th has been estimated.
{{ /callout }}

Adding border and descriptions

{{ callout
  type: warn
  title: System Notice
  border: true
}}
**Warning:** The following data sources are currently unavailable:
* Market data feed
* Currency exchange rates

Expected resolution: 2024-01-15 09:00 UTC.
{{ /callout }}

A danger callout

{{ callout
  type: danger
  border: true
}}
**Critical:** This report could not be generated. Please contact
the analytics team for assistance.
{{ /callout }}
Next
Tables