Markdown Callouts Guide

What are Callouts?

While basic markdown only provides simple blockquotes (>), GitHub introduced enhanced design features that allow writers to emphasize specific content and clearly convey intent to readers through callout functionality. This feature has been adopted by other markdown rendering tools like GitLab and Obsidian and is now widely used.

Difference from Basic Markdown Blockquotes

Basic blockquote syntax:

> This is a basic markdown blockquote.
> It only provides a simple gray vertical line and indentation.

Rendered result:

This is a basic markdown blockquote. It only provides a simple gray vertical line and indentation.

In contrast, callouts provide rich visual elements like colors, icons, and titles to clearly convey the nature of the content.

Basic Usage

Callouts use the following syntax:

> [!type]
> Callout content

[!tip] Case Sensitivity Rules Callout types are case-insensitive. [!NOTE], [!note], and [!Note] all work identically.

However, it's recommended to choose one consistent rule:

Lowercase ([!note]): Faster typing without Shift key
Uppercase ([!NOTE]): More visually prominent and formal

Recommendation: Use lowercase. With markdown linters (standardization tools), you can automatically convert all callouts to uppercase later if needed, so it's more efficient to use convenient lowercase during writing and convert with tools when necessary.

Examples

> [!note]
> This is a note callout.

> [!warning]
> This is a warning callout.

> [!tip] Custom Title
> You can add a custom title.

Markdown Platform Callout/Alert Support Comparison

Callout Type	GitHub	GitLab	Obsidian
NOTE	✅	✅	✅
TIP	✅	✅	✅
IMPORTANT	✅	✅	✅
WARNING	✅	✅	✅
CAUTION	✅	✅	✅
info	❌	❌	✅
todo	❌	❌	✅
abstract	❌	❌	✅
summary	❌	❌	✅
tldr	❌	❌	✅
hint	❌	❌	✅
success	❌	❌	✅
check	❌	❌	✅
done	❌	❌	✅
question	❌	❌	✅
help	❌	❌	✅
faq	❌	❌	✅
attention	❌	❌	✅
failure	❌	❌	✅
fail	❌	❌	✅
missing	❌	❌	✅
danger	❌	❌	✅
error	❌	❌	✅
bug	❌	❌	✅
example	❌	❌	✅
quote	❌	❌	✅
cite	❌	❌	✅

Basic Information Callouts

Used to display basic information or notes that users should be aware of.

Note

GitHub	GitLab	Obsidian
✅	✅	✅

Info

GitHub	GitLab	Obsidian
❌	❌	✅

Todo

GitHub	GitLab	Obsidian
❌	❌	✅

Help and Suggestion Callouts

Used to provide helpful tips or emphasize important information for users.

Tip

GitHub	GitLab	Obsidian
✅	✅	✅

Hint

GitHub	GitLab	Obsidian
❌	❌	✅

Important

GitHub	GitLab	Obsidian
✅	✅	✅

Question and Help Callouts

Used to address user questions or provide assistance.

Question

GitHub	GitLab	Obsidian
❌	❌	✅

Help

GitHub	GitLab	Obsidian
❌	❌	✅

FAQ

GitHub	GitLab	Obsidian
❌	❌	✅

Warning and Caution Callouts

Used to convey warnings or cautionary information to users.

Warning

GitHub	GitLab	Obsidian
✅	✅	✅

Caution

GitHub	GitLab	Obsidian
✅	✅	✅

Attention

GitHub	GitLab	Obsidian
❌	❌	✅

Success and Completion Callouts

Used to display successful results or completed tasks.

Success

GitHub	GitLab	Obsidian
❌	❌	✅

Check

GitHub	GitLab	Obsidian
❌	❌	✅

Done

GitHub	GitLab	Obsidian
❌	❌	✅

Summary and Organization Callouts

Used to summarize content or provide concise key points.

Abstract

GitHub	GitLab	Obsidian
❌	❌	✅

Summary

GitHub	GitLab	Obsidian
❌	❌	✅

TLDR

GitHub	GitLab	Obsidian
❌	❌	✅

Error and Problem Callouts

Used to display errors, failures, and issues.

Failure

GitHub	GitLab	Obsidian
❌	❌	✅

Fail

GitHub	GitLab	Obsidian
❌	❌	✅

Missing

GitHub	GitLab	Obsidian
❌	❌	✅

Danger

GitHub	GitLab	Obsidian
❌	❌	✅

Error

GitHub	GitLab	Obsidian
❌	❌	✅

Bug

GitHub	GitLab	Obsidian
❌	❌	✅

Example and Citation Callouts

Used to show examples or cite content from other sources.

Example

GitHub	GitLab	Obsidian
❌	❌	✅

Quote

GitHub	GitLab	Obsidian
❌	❌	✅

Cite

GitHub	GitLab	Obsidian
❌	❌	✅

Advanced Features

Adding Titles (Supported by All Platforms)

GitHub	GitLab	Obsidian
✅	✅	✅

Folding/Expanding Feature (Obsidian Only)

GitHub	GitLab	Obsidian
❌	❌	✅

Syntax:

> [!info]- Collapsed by Default
> Using the minus (-) symbol displays the callout collapsed by default.

> [!info]+ Expanded by Default
> Using the plus (+) symbol displays the callout expanded by default.

Rendered result:

Collapsed by Default

Using the minus (-) symbol displays the callout collapsed by default.

Expanded by Default

Using the plus (+) symbol displays the callout expanded by default.

Nested Callouts (Obsidian Only)

GitHub	GitLab	Obsidian
❌	❌	✅

Syntax:

> [!warning] Outer Callout
> This is the outer callout.
> 
> > [!tip] Inner Callout
> > You can nest other callouts inside a callout.

Rendered result: