Callouts and Quotes
2025, 05 DecCallouts are those colored thingies that highlight important information. Blockquotes are for, well, quoting stuff. Here's how they look like.
Callout Types
Different types for different purposes:
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.
Something to watch out for.
Critical issues requiring immediate attention.
Positive outcomes or completed tasks.
Errors or unsuccessful operations.
FAQs or prompts for consideration.
Concrete examples or code snippets.
Custom Titles
Callouts can have titles:
Breaking Change
This API will change in version 2.0. Check the migration guide before upgrading.
Performance Optimization
Batch operations reduce overhead when processing large datasets.
Collapsible Callouts
You can make a callout collapsed by default (click to expand):
And you can make it expanded by default but still collapsible:
This starts open but can be collapsed. Good for optional content that most readers will want to see.
Rich Content
Callouts can contain paragraphs, lists, code, images, and more:
Mixed Content
Here's a paragraph explaining the concept.
A list of requirements:
- Rust 1.70+
- Basic Rust knowledge
- A text editor
And some code:
let users: Vec<User> = db.query("SELECT * FROM users").await?;
println!("{:#?}", users);Blockquotes
Standard markdown blockquotes are turned into quotations:
Design is not just what it looks like and feels like. Design is how it works.
You can them with optional attribution:
Any fool can write code that a computer can understand. Good programmers write code that humans can understand.
That covers callouts and quotes. Use them to break up walls of text and highlight what matters.