Markdown

Callouts

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

AI assisted, human approved — novem uses AI to review and keep our documentation up to date.

Available in: documents and e-mails.

{{ callout                              # section type
  type: warn                            # type of callout
  desc: Warnings reported by our        # callout prefix
        system                          # message
  border: true                          # callout border
}}

We let our users generate helpful       # callout content can
callouts to display in their e-mails.   # be written using
                                        # simple novem markdown
Currently supported are
 * Warnings
 * Errors
 * Information
 * And success

{{ /callout }}                           # callouts must be terminated
                                        # with the /callout section

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 multi statement section with the keyword callout; its content supports simple novem markdown.

Options to the section are supplied as yaml within the double brackets.

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.

keyword: border
options: true | false
default: false

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

keyword: desc
options: "Description text"

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

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


{{ callout
  type: warn
  desc: 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 }}


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