Markdown Callouts: Note and Warning Boxes

Callouts and alerts in Markdown (note, warning, tip)

Blocks

Markdown syntax

Some tools only

> [!NOTE]
> Useful information.

GitHub alert. The type goes on the first line of a blockquote.

Callouts are not part of CommonMark. GitHub and Obsidian both read a blockquote whose first line is [!NOTE], [!TIP], [!IMPORTANT], [!WARNING] or [!CAUTION] as a colored box. Where they are not supported, the reader still sees a normal quote, so the content survives.

All ways to write it

```
> [!NOTE]
> Useful information.
```
GitHub alert. The type goes on the first line of a blockquote.Some tools only
```
> [!TIP]
```
Also [!IMPORTANT], [!WARNING] and [!CAUTION]. These five are the types GitHub supports.Some tools only
```
> [!info]- Click to open
```
Obsidian callouts use the same form, with more types and a - to fold them.Some tools only
```
:::note
Useful information.
:::
```
Admonitions in Docusaurus. VitePress uses ::: tip and MkDocs uses !!! note.Some tools only

Example

You type

> [!WARNING]
> Back up the space before importing over existing pages.

On GitHub this renders as a yellow Warning box. In a renderer without alerts, it is a normal blockquote that starts with [!WARNING].

Questions

Can I change the title of a GitHub alert?

No. GitHub shows the type name. Obsidian lets you write a title after the type: > [!tip] Faster imports.

Can an alert hold a list or code?

Yes. Anything that can go in a blockquote can go in an alert, as long as each line starts with >.

Callout (note, warning) in Confluence

Confluence's version is the panel: info, note, warning, success and error. Markdown Exporter turns panels into these callouts by default (Info to [!INFO], Note to [!NOTE], Warning to [!WARNING], Success to [!TIP], Error to [!CAUTION]), so they show as boxes again on GitHub and in Obsidian. A Blockquote or Plain text setting covers tools without callouts.