Callouts

Create styled callout boxes for notes, warnings, and critical information in your documentation.

Callouts draw attention to important information by displaying content in visually distinct boxes. Mordoc supports three types of callouts: note, warning, and danger.

Syntax

Create callouts using syntax:

Markdown
{% callout type="note" title="Note" %}
Even the smallest person can change the course of the future.
{% /callout %}

Callout types

Note callouts

Use notes for helpful tips, additional context, or supplementary information:

SyntaxResult
Markdown
{% callout type="note" title="Pro tip" %}
When at the gates of Moria, say *mellon*.
{% /callout %}
Pro tip

When at the gates of Moria, say mellon.

Warning callouts

Use warnings for important information that users should be aware of:

SyntaxResult
Markdown
{% callout type="warning" title="Warning" %}
Some enemies, like the Balrog beneath the mountain, are not meant to be fought at all
{% /callout %}
Warning

Some enemies, like the Balrog beneath the mountain, are not meant to be fought at all

Danger callouts

Use danger callouts for critical warnings about destructive or risky actions:

SyntaxResult
Markdown
{% callout type="danger" title="Danger" %}
Do not claim the Ring for yourself, or it will claim you in return.
{% /callout %}
Danger

Do not claim the Ring for yourself, or it will claim you in return.

Callouts without titles

You can also write callouts without titles:

SyntaxResult
Markdown
{% callout type="note" %}
Even the smallest person can change the course of the future.
{% /callout %}

Even the smallest person can change the course of the future.

Next steps