Skip to content

Instantly share code, notes, and snippets.

@MakePixelsWork
Last active May 16, 2024 08:39
Show Gist options
  • Save MakePixelsWork/8244a2c78c00d229a8922b7dc28d04da to your computer and use it in GitHub Desktop.
Save MakePixelsWork/8244a2c78c00d229a8922b7dc28d04da to your computer and use it in GitHub Desktop.
GitHub flavoured alerts for your Markdown documentation

GitHub flavoured alerts

You can use these GitHub flavoured Markdown alerts, to emphasize texts inside your GitHub documentation. I created this Gist, because I constantly lost the link to this beta development, which is here: https://github.com/orgs/community/discussions/16925

> [!NOTE]  
> Highlights information that users should take into account, even when skimming.

> [!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.

Which shows alerts like this:

Note

Highlights information that users should take into account, even when skimming.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment