Skip to content
Markdown Viewer

Callout & Admonition Generator

Build Markdown callouts for GitHub, Docusaurus, MkDocs, and Obsidian

One body, four ready-to-paste syntaxes. Compose note / tip / important / warning / caution callouts and copy the variant for your destination — GitHub alerts, Obsidian, Docusaurus, or MkDocs Material.

Preview in editorEmoji pickerGFM checklist

GitHub

GitHub-flavored alerts: > [!NOTE]

> [!NOTE]
> **Heads up**
>
> Use admonitions sparingly — one or two per long page is plenty.
> Multiline content is supported.

Obsidian

Obsidian callouts: > [!note]

> [!note] Heads up
> Use admonitions sparingly — one or two per long page is plenty.
> Multiline content is supported.

Docusaurus / VitePress

:::note ... :::

:::note[Heads up]
Use admonitions sparingly — one or two per long page is plenty.
Multiline content is supported.
:::

MkDocs Material

!!! note ...

!!! note "Heads up"
    Use admonitions sparingly — one or two per long page is plenty.
    Multiline content is supported.

How to use the callout generator

  1. Pick a kind — note, tip, important, warning, or caution. The kind drives the icon and color on each platform.
  2. Add an optional title to override the default heading (e.g., "Heads up" instead of "Note").
  3. Type the body — multi-line is fine.
  4. Copy the variant for the platform you're publishing to.

When to use callouts

  • Note — supplementary info that a reader can skip and still understand the section.
  • Tip — efficiency hint or alternate approach.
  • Important — something the reader must understand for the section to make sense.
  • Warning — non-destructive caution; for example, a deprecated path.
  • Caution — risk of data loss or security impact.

Use sparingly. One or two callouts per page draws the eye; a dozen feels like a wall of nags.

Syntax at a glance

> [!NOTE]
> This is a GitHub alert. Renders with a colored bar in GitHub Markdown.

:::note Heads up
This is a Docusaurus / VitePress admonition.
:::

!!! note "Heads up"
    This is an MkDocs Material admonition (indent body 4 spaces).

> [!note] Heads up
> This is an Obsidian callout — same shape as GitHub with optional title.

Tips that pay off later

  • Keep the title short — most renderers cap at one line, and long titles wrap awkwardly.
  • Don't nest callouts — renderer support is inconsistent and the visual chrome doubles.
  • Use the lowest severity that fits — promote a Note to a Warning only when missing it has real consequences.
  • Pair with Markdown Emoji Picker for static renderers that don't support callouts: ℹ️ Note, ⚠️ Warning, etc.

Companion tools

Privacy & data

The generator runs entirely in your browser. Nothing leaves the tab.

Frequently asked questions

What is a Markdown callout or admonition?
It's a visually distinct block — often colored — used to highlight notes, tips, warnings, or important asides inside a Markdown document. GitHub recently added native support (> [!NOTE]), and platforms like Docusaurus, MkDocs Material, and Obsidian have their own syntax for the same feature.
Why does every platform have its own syntax?
Admonitions aren't part of the CommonMark or GFM spec. Each platform shipped its own extension before any standard emerged. GitHub's recent `> [!NOTE]` alerts are the closest thing to a de-facto standard, and Obsidian uses a near-identical syntax — but Docusaurus and MkDocs predate them.
Which callout kinds are supported?
Five common kinds: note, tip, important, warning, caution. GitHub's alerts officially support all five. Docusaurus and MkDocs accept any string, so these five work across the board.
Can callouts contain multi-line content?
Yes. Type as many lines as you need in the body; each output style formats them appropriately. GitHub and Obsidian use `>` line prefixes, MkDocs uses 4-space indentation, and Docusaurus wraps the body in fenced delimiters.
Will GitHub render Docusaurus or MkDocs admonitions?
No. Each renderer only handles its own syntax. For cross-platform compatibility, stick with GitHub-style alerts when publishing to GitHub and use the platform-native style for your docs site.
Is my content uploaded?
No. All four outputs are generated by a small client-side string transform. Nothing leaves your browser tab.