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.

Tips

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.

Contributors

pengzhanbo

Changelog

12/1/25, 3:30 AM

View All Changelog

• db8a4-docs: optimize and completion docs (#766)on 12/1/25

Edit this page

Previous pagecontainer

Next pageCard