Skip to content

Demo

A GitHub note alert renders as a Starlight note aside by default.

> [!NOTE]
> Useful information that users should know, even when skimming content.
Preview

A GitHub tip alert renders as a Starlight tip aside by default.

> [!TIP]
> Helpful advice for doing things better or more easily.
Preview

A GitHub important alert renders as a Starlight caution aside by default.

> [!IMPORTANT]
> Key information users need to know to achieve their goal.
Preview

A GitHub warning alert renders as a Starlight caution aside by default.

> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.
Preview

A GitHub caution alert renders as a Starlight danger aside by default.

> [!CAUTION]
> Advises about risks or negative outcomes of certain actions.
Preview