Markdown Callout Generator
GitHub, GitLab and Obsidian callouts — pick a type, copy the syntax
GitHub has five fixed alert types. GitLab supports the same five plus custom titles. Obsidian adds its own type names, custom titles and collapsible callouts.
> [!NOTE] > Use callouts to make key information impossible to miss. > They work in READMEs, issues, docs, and notes.
NOTE
Use callouts to make key information impossible to miss.
They work in READMEs, issues, docs, and notes.
How Markdown callouts work
A callout is a blockquote whose first line carries a [!TYPE] marker. GitHub and GitLab render five shared types — NOTE, TIP, IMPORTANT, WARNING and CAUTION — each with its own colour and icon. GitLab also accepts a custom title on the marker line. Obsidian accepts lowercase types, adds thirteen built-ins, and supports custom titles plus -/+ markers that make the callout collapsible.
| Feature | GitHub | GitLab | Obsidian |
|---|---|---|---|
| Types | 5 fixed, uppercase | Same 5, case-insensitive | 13 built-in, lowercase (with aliases) |
| Custom title | No | Yes — text after the marker | Yes — text after the marker |
| Collapsible | No | No | Yes — - or + after the marker |
| Where it renders | READMEs, issues, PRs, discussions | Markdown text boxes and files | Notes in your vault |
Writing notes rather than READMEs? Every built-in Obsidian type is documented on the Obsidian callouts guide, and the GitHub cheat sheet covers alerts alongside the rest of GFM.