GitHub Alerts
GitHub-style alerts and callouts
Gha
Aka. "GitHub alerts"
<Gha keyword="NOTE">Highlights information that users should take into account, even when skimming.</Gha>
or better:
> [!NOTE]
> Highlights information that users should take into account, even when skimming.
Result
Note
Highlights information that users should take into account, even when skimming.
We also support: [!TIP], [!IMPORTANT], [!WARNING], [!CAUTION]
Result
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.