Markdown for info panel/warning box

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.

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/

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/

test

[!NOTE TEST]
Useful information that users should know, even when skimming content.

Tip

Helpful advice for doing things better or more easily.

Important

Key information users need to know to achieve their goal.

Warning

Urgent info that needs immediate user attention to avoid problems.

Caution

Advises about risks or negative outcomes of certain actions.