Use the callout shortcode to draw attention to important information. Four context types are available: note (default), info, warning, and danger.

Usage

{{< callout "note" >}}
Your message here.
{{< /callout >}}

Or with named parameters:

{{< callout context="warning" title="Watch out" >}}
This action cannot be undone.
{{< /callout >}}

Parameters

ParameterTypeDefaultDescription
context (or positional 0)stringnoteSets the callout style. One of note, info, warning, or danger.
titlestringOptional heading displayed above the body. Supports Markdown.
iconstringOptional path to an SVG icon to display.

Examples

Note

Preview

This is a default note callout.

{{< callout >}}
This is a default note callout.
{{< /callout >}}

Info

Preview

Doks uses npm and Hugo mounts to manage dependencies.

{{< callout "info" >}}
Doks uses npm and Hugo mounts to manage dependencies.
{{< /callout >}}

Warning

Preview

Heads up

Changing this setting requires a full rebuild.

{{< callout context="warning" title="Heads up" icon="alert-triangle" >}}
Changing this setting requires a full rebuild.
{{< /callout >}}

Danger

Preview

Deleting this record is permanent and cannot be reversed.

{{< callout "danger" >}}
Deleting this record is **permanent** and cannot be reversed.
{{< /callout >}}