Skip to content

Instantly share code, notes, and snippets.

@sleeyax
Created January 28, 2024 01:06
Show Gist options
  • Save sleeyax/4e198bb784e0396823d13bef1c841a00 to your computer and use it in GitHub Desktop.
Save sleeyax/4e198bb784e0396823d13bef1c841a00 to your computer and use it in GitHub Desktop.
Beautfiful markown snippets

Alerts

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.

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