Skip to content

Instantly share code, notes, and snippets.

@manuelcoppotelli

manuelcoppotelli/markdown_examples.md

Forked from cseeman/markdown_examples.md
Created February 20, 2024 14:56
Show Gist options
  • Save manuelcoppotelli/5465de80ac7b14803cf756425f878a5c to your computer and use it in GitHub Desktop.
Save manuelcoppotelli/5465de80ac7b14803cf756425f878a5c to your computer and use it in GitHub Desktop.
Download ZIP
Markdown for info panel/warning box
Raw
markdown_examples.md

Examples for how to create your own info panel, warning box and other decent looking notification in GitHub markdown.

All the boxes are single/two cell tables or two row tables.

Warning box

❗ You have to read about this
⚡ Risky setup going on here!
⚠️ WARNING
Another way to warn you
💥 DANGER
Whoa there with this config

Info panel

📝 This is something that is good to note
☝️ Hey did you actually read the doc above?

Other markdown options

Note

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

Important

Crucial information necessary for users to succeed.

Warning

Critical content demanding immediate user attention due to potential risks.

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