Alerts

Github Flavored Markdown (GFM) supports alerts, also called callouts or admonitions.

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.

Optionally a title can be added to the alert:

For your attention

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

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