Skip to content

Instantly share code, notes, and snippets.

@MSch
Forked from cseeman/markdown_examples.md
Created February 21, 2025 20:58
Show Gist options
  • Save MSch/81deeabbb4af69d7d7f41be569e07172 to your computer and use it in GitHub Desktop.
Save MSch/81deeabbb4af69d7d7f41be569e07172 to your computer and use it in GitHub Desktop.
Markdown for info panel/warning box

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.

Also available the tip and caution alerts:

Tip

Helpful advice for doing things better or more easily. Tip

Helpful advice for doing things better or more easily.

Caution

Advises about risks or negative outcomes of certain actions. Caution

Advises about risks or negative outcomes of certain actions.

Source: https://github.blog/changelog/2023-12-14-new-markdown-extension-alerts-provide-distinctive-styling-for-significant-content/

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