Skip to content

Instantly share code, notes, and snippets.

@jimbrig

jimbrig/README.md

Created February 17, 2024 02:13
Show Gist options
  • Save jimbrig/a266e670593c35e8265ec54af40b4fbb to your computer and use it in GitHub Desktop.
Save jimbrig/a266e670593c35e8265ec54af40b4fbb to your computer and use it in GitHub Desktop.
Download ZIP
GitHub Markdown Callouts
Raw
README.md

New GitHub Markdown Callout Syntax Reference

Source: 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.

produces:

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