Markdown Alerts Syntax Guide

Fulcrum

Alerts are an extension of Markdown used to emphasize critical information. While not in the base CommonMark spec, many popular platforms, such as GitHub, GitLab and Obsidan, support these in their markdown flavours.

â„šī¸ Note

Highlights information that users should take into account, even when skimming.

💡 Tip

Optional information to help a user be more successful.

❕ Important

Crucial information necessary for users to succeed.

âš ī¸ Warning

Critical content demanding immediate user attention due to potential risks.

❗ Caution

Negative potential consequences of an action.

> [!NOTE]
> Highlights information that users should take into account, even when skimming.

> [!TIP]
> Optional information to help a user be more successful.

> [!IMPORTANT]
> Crucial information necessary for users to succeed.

> [!WARNING]
> Critical content demanding immediate user attention due to potential risks.

> [!CAUTION]
> Negative potential consequences of an action.