Callouts

Callouts are colored boxes that highlight important information. Blockquotes are for quotations.

Callout Types

Use > [!TYPE] to create a callout:

> [!warning]
> Something to watch out for.

Renders as:

Something to watch out for.

Here are all the types you can use:

Type	Aliases	Purpose
`note`		General supplementary information
`info`		Informational emphasis
`tip`	`hint`, `important`	Helpful advice and best practices
`link`		Related resources or references
`question`	`help`, `faq`	FAQs or prompts for consideration
`warning`	`caution`, `attention`	Something to watch out for
`danger`	`error`	Critical issues requiring attention
`failure`	`fail`, `missing`	Errors or unsuccessful operations
`success`	`check`, `done`	Positive outcomes or completed tasks
`example`		Concrete examples

General information that supplements the main text.

Similar to note, but emphasizes informational content.

Helpful advice or best practices.

Highlight related resources or external references.

FAQs or prompts for consideration.

Something to watch out for.

Critical issues requiring immediate attention.

Errors or unsuccessful operations.

Positive outcomes or completed tasks.

Concrete examples or code snippets.

Type names are case-insensitive — [!WARNING], [!Warning], and [!warning] all work.

Custom Titles

Add a title after the type:

> [!warning] Breaking Change
> This API will change in version 2.0.

Renders as:

Breaking Change

This API will change in version 2.0.

Collapsible Callouts

Add - (collapsed by default) or + (expanded by default) after the type to make a callout collapsible:

> [!note]- Collapsed by default
> Hidden until you click the header.

Renders as:

> [!tip]+ Expanded by default
> Starts open but can be collapsed.

Renders as:

Starts open but can be collapsed.

Without a suffix, the callout is always visible and not collapsible.

Rich Content

You can put almost anything inside a callout — paragraphs, lists, code blocks, images, you name it:

> [!example] Mixed Content
>
> Here's a paragraph explaining the concept.
>
> A list of requirements:
> - Rust 1.70+
> - Basic Rust knowledge
>
> And some code:
> ```rust
> let x = 42;
> ```

Renders as:

Mixed Content

Here's a paragraph explaining the concept.

A list of requirements:

Rust 1.70+
Basic Rust knowledge

And some code:

rust

let x = 42;

Blockquotes

Regular markdown blockquotes render as quotations:

> Design is not just what it looks like and feels like.
> Design is how it works.

Renders as:

Design is not just what it looks like and feels like.
Design is how it works.

Add attribution with -- on the last line:

> Any fool can write code that a computer can understand.
> Good programmers write code that humans can understand.
>
> -- Martin Fowler

Renders as:

Any fool can write code that a computer can understand.
Good programmers write code that humans can understand.

Martin Fowler