Skip to content

Instantly share code, notes, and snippets.

@sfate

sfate/Github blockquote highlights.md

Created May 3, 2024 16:57
Show Gist options
  • Save sfate/27f7bd7cd5322baaba8091f7222e9a83 to your computer and use it in GitHub Desktop.
Save sfate/27f7bd7cd5322baaba8091f7222e9a83 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
Github blockquote highlights.md

Alerts are an extension of Markdown used to emphasize critical information. On GitHub, they are displayed with distinctive colors and icons to indicate the importance of the content.

An example of all five types:

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

Here is how they are displayed:

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.

Reference: https://github.com/orgs/community/discussions/16925

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