Skip to content

Instantly share code, notes, and snippets.

@ayoayco

ayoayco/gh-alerts.md

Created December 14, 2023 12:16
Show Gist options
  • Save ayoayco/254a4b5220b880fd53989825980ddb88 to your computer and use it in GitHub Desktop.
Save ayoayco/254a4b5220b880fd53989825980ddb88 to your computer and use it in GitHub Desktop.
Download ZIP
GH Alerts in MD files
Raw
gh-alerts.md

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.

> [!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.
@ayoayco
Copy link
Author

ayoayco commented Jan 13, 2024 •
edited
Loading

Related discussion on GH project: 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