Skip to content

Instantly share code, notes, and snippets.

@cseeman

cseeman/markdown_examples.md

Created September 15, 2023 16:48
Show Gist options
  • Star 16 You must be signed in to star a gist
  • Fork 6 You must be signed in to fork a gist
  • Save cseeman/8f3bfaec084c5c4259626ddd9e516c61 to your computer and use it in GitHub Desktop.
Save cseeman/8f3bfaec084c5c4259626ddd9e516c61 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.

@JuanJesusAlejoSillero
Copy link

JuanJesusAlejoSillero commented Apr 26, 2024 •
edited

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