Files
oam/snippets/info-blocks.github.md

34 lines
801 B
Markdown

<!-- markdownlint-disable-file MD041 -->
The idea here is to mimic Confluence's Info panel.
> Only works in places using Github's Markdown.
Use Github's [Alert extension](https://github.blog/changelog/2023-12-14-new-markdown-extension-alerts-provide-distinctive-styling-for-significant-content/).<br/>
See <https://github.com/sinsukehlab/NOTE-test/blob/main/NOTE.md> for more examples.
---
> [!NOTE]
> 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.