1.2 KiB

url
url
/en/guide/markdown/github-alerts/index.md

GitHub-Style Alerts

The theme supports rendering GitHub-style alerts through callouts. They are rendered in the same way as hint containers.

Input:

> [!NOTE]
> Highlights information that users should take note of even when skimming.

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

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

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

> [!CAUTION]
> Advises about negative outcomes from specific actions.

Output:

[!NOTE] Highlights information that users should take note of even when skimming.

[!TIP] Optional information to help users be more successful.

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

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

[!CAUTION] Advises about negative outcomes from specific actions.