Gha

GitHub-style alerts and callouts

Summary

GitHub-style alerts with multiple severity levels.

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.


The title prop overrides the label derived from keyword (icon and background still follow the keyword). Only available via the JSX form:

<Gha keyword="TIP" title="MCP-server">Browse these docs from your MCP-compatible client.</Gha>

result:

MCP-server

Browse these docs from your MCP-compatible client.