Alerts

Alerts are callouts that provide information or instruct the user to take action. Available as leaf (::alert[...]) and container (:::alert ... :::) directives.

Properties: header (string), type (info | success | warning | error, default info).

Basic

Rendered:

Example alert message

Source:

1
::alert[Example alert message]

With a header

Rendered:

Example header

Example alert message

Source:

1
::alert[Example alert message]{header="Example header"}

Every type

Rendered:

Info

Informational message. This is the default type.

Success

Operation completed successfully.

Warning

Double-check this step before continuing.

Error

This action cannot be undone!

Source:

1
2
3
4
5
6
7
::alert[Informational message. This is the default type.]{header="Info" type="info"}

::alert[Operation completed successfully.]{header="Success" type="success"}

::alert[Double-check this step before continuing.]{header="Warning" type="warning"}

::alert[This action cannot be undone!]{header="Error" type="error"}

Complex content (container)

Use the container form to wrap lists, code and other directives inside an alert.

Rendered:

Important

Make sure to update your local mainline branch before creating a new feature branch:

Checkout your local mainline branch
Fetch changes from remote
Rebase your local mainline branch
Finally, create and checkout your feature branch

Source:

1
2
3
4
5
6
7
8
:::alert{header="Important" type="warning"}
Make sure to update your local mainline branch before creating a new feature branch:

1. Checkout your local `mainline` branch
1. Fetch changes from remote
1. Rebase your local `mainline` branch
1. Finally, create and checkout your feature branch
:::