⌘ K
GitHub · MkDocs · Obsidian

Build callouts and admonitions

Note, tip, important, warning, caution — output the syntax for GitHub flavored Markdown, MkDocs Material, or Obsidian.

Callout Generator
Markdown
50 B
2 lines
Flavor
github
renderer
Kind
note
severity
Title
default
note
input · fields
output · markdown
> [!NOTE]
> This is a callout. **Bold** works too.
Quick Start

How to build a callout

Each flavor has its own syntax. Pick the one your renderer supports, then copy the output.

  1. 01

    Choose a flavor

    GitHub uses blockquote syntax; MkDocs uses bang prefix; Obsidian uses a hybrid.

    Parsing runs through marked with GFM extensions enabled — tables, task lists, strikethrough, and fenced code blocks all match GitHub’s rendering.

    flavorGFMmarkedCommonMarklive
    flavor · markdowngithub · GFM
    [!NOTE]
    loaded · GFMGFM · ready
  2. 02

    Pick a kind

    Note, tip, important, warning, caution map to icon and color.

    Soft-break behaviour is configurable: by default a single newline becomes a space (CommonMark), toggle on for chat-style <br> insertion.

    kindsoft-breaksoptionsconfiglive
    kind · optionsnote · live
    > [!NOTE]
    options applied · livelive
  3. 03

    Add body

    Markdown inside the callout — bold, lists, links all work.

    The preview is scoped under a .mde class so its CSS doesn’t bleed into the rest of the page. Output HTML is whitespace-controlled for clean diffs.

    bodypreviewscoped CSSrenderstable
    body · renderedmd · ready
    > Heads up.
    rendered · liverendered
  4. 04

    Copy snippet

    Paste into your README, docs page, or vault note.

    Export covers both raw Markdown and rendered HTML; downloads stream as text/markdown or text/html via Blob + object URL.

    exportclipboard.md.htmlblob
    ✓ · exportedready · done
    ✓ Copied
    shipped · ready to shipsuccess
Pro tips

Author Markdown that renders everywhere

GFM is the safe default

GitHub-Flavored Markdown is the de-facto baseline (tables, task lists, strikethrough). CommonMark is stricter but ubiquitous as a fallback.

Soft-break behaviour varies

A single newline is a space in CommonMark, a <br> in GFM. Toggle soft breaks when source matters.

Escape inside code fences

Backticks inside fenced blocks need a longer fence — three becomes four. Use ~~~ if your content has many backticks.

Anchors are slugified

GitHub lowercases, strips punctuation, and joins with hyphens. Duplicate headings get -1, -2 suffixes.

Tables need a header row

The dash row sets alignment (:---, :-:, ---:). Use Table Aligner for diff-friendly columns.

Front matter is YAML

Triple-dash blocks at the top of files are parsed by static-site generators. Use the Front-Matter Validator to catch syntax errors.

Related toolsMD EditorGitHub PreviewCollapsiblesTabsCheatsheetREADME
Use Cases

When to use callouts

READMEs, docs, blog posts.

Highlight gotchas

Warning blocks for upgrade pitfalls. Render path uses marked with GFM extensions enabled (tables, task lists, strikethrough, autolinks), so what you preview matches what GitHub publishes bit-for-bit. Soft-break behaviour is configurable for chat-style vs prose Markdown.

GFM-compliant

Inline tips

Short tip cards beside examples. Pairs cleanly with the Markdown Cheatsheet for syntax you can't quite remember — callout blocks, footnotes, definition lists. Output stays diff-friendly so style-only changes don't drown out real edits in PRs.

GitHub-perfect

Release notes

Mark important breaking changes. Cross-platform safe: anchors, code fences, and tables behave identically on GitHub, GitLab, Bitbucket, and Gitea. Heading-anchor slugs follow GitHub's lowercase-and-hyphenate rules so deep links survive a docs migration.

diff-friendly

Security warnings

Call out CVE-related caution notes. No server roundtrip — perfect for proprietary content you can't paste into a public tool. The full marked + GFM bundle ships with the page, so it works offline once loaded.

render-stable

Migration guides

Step-by-step with notes inline. Front matter (YAML / TOML / JSON) passes through unchanged so static-site pipelines (Jekyll, Hugo, Astro, Eleventy) read it correctly. Pair with the Front-Matter Validator to catch syntax errors before deploy.

cross-platform

Obsidian vaults

Personal notes with typed callouts. Output is reproducible: identical input always produces identical Markdown, so doc-generation scripts can rely on it for snapshot tests and embedded into release workflows.

SEO-friendly
FAQ

Frequently asked questions

GitHub, MkDocs Material, and Obsidian use distinct syntaxes that don't fully overlap.
Yes — GitHub honors a second line as the callout title. The tool emits it when you fill the title field.
Some renderers support nesting; GitHub does not. Test in your engine before relying on it.
Pandoc has no built-in callout syntax. Use raw HTML or a custom div fence.
No. Snippet is generated in your browser.
Suggest a tool

Something missing?

Tell us what you need. We ship the top requests every two weeks.

Sent straight to the maintainers · no account needed
47 in queue·8 shipped this month
Request queued. Thanks!