Markdown Callout and Alert Generator
Generate markdown callouts, GitHub alerts, Obsidian callouts and MkDocs admonitions. Pick a type, write the note and copy the exact syntax. Free tool.
Five types; no custom title; no folding.
> [!WARNING] > **Back up before upgrading** > The migration rewrites the `settings` table. > Run `npm run backup` first, then `npm run migrate`.
Warning
Back up before upgrading
The migration rewrites the settings table.
Run npm run backup first, then npm run migrate.
GitHub alerts
> [!WARNING] > **Back up before upgrading** > The migration rewrites the `settings` table. > Run `npm run backup` first, then `npm run migrate`.
Obsidian callouts
> [!warning] Back up before upgrading > The migration rewrites the `settings` table. > Run `npm run backup` first, then `npm run migrate`.
MkDocs Material
!!! warning "Back up before upgrading"
The migration rewrites the `settings` table.
Run `npm run backup` first, then `npm run migrate`.Docusaurus
:::warning[Back up before upgrading] The migration rewrites the `settings` table. Run `npm run backup` first, then `npm run migrate`. :::
GitLab alerts
> [!warning] > **Back up before upgrading** > The migration rewrites the `settings` table. > Run `npm run backup` first, then `npm run migrate`.
Plain blockquote
> **Warning: Back up before upgrading** > > The migration rewrites the `settings` table. > Run `npm run backup` first, then `npm run migrate`.
What Are Obsidian Callouts and Markdown Callouts?
Obsidian callouts are blockquotes that start with a type tag such as > [!note] and render as a coloured box with an icon and optional title. Every major markdown platform has its own version of the idea: GitHub calls them alerts, MkDocs and Sphinx call them admonitions, Docusaurus uses:::note fences, and GitLab recently adopted the GitHub syntax. The syntaxes are not compatible with each other, which is what this generator solves. Type the note once, pick the target, and copy the exact markdown callouts syntax that platform expects.
Generation happens in your browser; nothing is uploaded.
How to Generate a Callout
- Pick a type. The first five (Note, Tip, Important, Warning, Caution) exist everywhere; the rest are Obsidian and MkDocs types.
- Choose the target platform. The note under the toolbar explains what that platform supports.
- Add an optional title and write the body in markdown; lists, code and links are allowed inside.
- For Obsidian or MkDocs, set Foldable to open or collapsed.
- Copy the output, or scroll to All targets to grab every syntax at once.
Callout Syntax by Platform
| Platform | Syntax | Types | Title | Foldable |
|---|---|---|---|---|
| GitHub alerts markdown | > [!WARNING] | 5 | No | No |
| Obsidian | > [!warning]- Title | 14 (+ aliases) | Yes | + / - |
| MkDocs Material | !!! warning "Title" | 12 | Yes | ??? / ???+ |
| Docusaurus | :::warning[Title] | 5 | Yes | No |
| GitLab | > [!warning] | 5 | No | No |
| Plain blockquote | > **Warning:** ... | any | Bold text | No |
Writing a Markdown Admonition That Reads Well
A markdown admonition interrupts the flow of the page, so use it for information the reader must not miss: a destructive command, a version requirement, a security note. Keep the body to two or three sentences and put the action first ("Run a backup before migrating"). Use Warning for things that can go wrong and Caution for things that cause damage; GitHub renders the two in different colours for that reason. Avoid stacking several callouts in a row, and never put a heading inside one, since most renderers drop it.
Obsidian Callouts Outside Obsidian
Notes written in Obsidian often end up in a GitHub README or a docs site, where obsidian callouts fall back to an ordinary quote with a stray [!note] tag. Regenerating the block here with the right target avoids that. When a type has no equivalent, the generator picks the closest one: bug, failure and danger become CAUTION on GitHub, success becomes TIP, and question becomes IMPORTANT. For documents that need to work everywhere, the plain blockquote output is the safe choice.
Frequently Asked Questions
How do I write obsidian callouts?
Start a blockquote with the type in square brackets: > [!note] Optional title, then continue the body on lines that also start with >. Obsidian callouts accept a + or - after the closing bracket to make the block foldable and open or collapsed by default. The generator writes this exact syntax for all fourteen built-in types.
What are GitHub alerts and which types exist?
GitHub alerts are blockquotes that start with > [!NOTE], > [!TIP], > [!IMPORTANT], > [!WARNING] or > [!CAUTION]. Only those five types exist, titles are not supported, and the tag must be on its own line. GitLab supports the same five with a lowercase tag.
How do markdown admonitions work in MkDocs?
MkDocs Material uses !!! type "Title" on one line followed by the body indented by four spaces. Replace !!! with ??? for a collapsed block or ???+ for an expanded one. The Admonition extension must be enabled in mkdocs.yml.
Which syntax should I use for a markdown warning box that works everywhere?
Choose the Plain blockquote target. It writes > **Warning: Title** followed by the body, which every markdown renderer shows as an ordinary quote. The styled callout appears only on platforms that support the specific syntax, so use plain when the file is read in several places.
Does the tool convert between Obsidian and GitHub syntax?
It generates all six targets at once from one input, so you can copy the GitHub version for a README and the Obsidian version for your vault. Types that GitHub lacks, such as bug or success, are mapped to the nearest alert type (CAUTION and TIP). To convert whole notes, use the Obsidian to Markdown converter.