Admonitions are special callout blocks used to highlight important information in Markdown. They help make content more structured and visually engaging.
Basic Admonitions
Information
This is an informational callout. Use it to highlight useful details.
> [!info]
> This is an informational callout. Use it to highlight useful details.Note
Notes provide additional context or clarifications.
> [!note]
> Notes provide additional context or clarifications.Tip
Tips offer helpful advice or best practices.
> [!tip]
> Tips offer helpful advice or best practices.Foldable Callouts
You can create foldable callouts to hide or expand content when needed.
What is an FAQ callout?
This is a foldable FAQ callout. Click to expand and reveal the answer.
> [!faq]- What is an FAQ callout?
> This is a foldable FAQ callout. Click to expand and reveal the answer.Nested Callouts
Admonitions can be nested for better structuring of complex information.
> [!question] What should I do?
> > [!todo] Make a checklist
> > > [!example] Here is an example checklist for reference.Supported Admonition Types
There are various types of callouts available:
Use for summarizing key points.
A to-do list or pending tasks reminder.
Indicates a successful operation or positive outcome.
Used for raising questions or discussions.
Warns users about potential risks or issues.
Highlights a failure or an error situation.
Use for critical warnings or severe risks.
Reports a bug or issue.
Provides an example or use case.
Displays a quoted text for emphasis.
> [!Abstract]
> Use for summarizing key points.Similarly, you can use other types of admonitions by replacing info with the desired type, such as warning, success, or bug.
Using admonitions effectively can enhance readability and comprehension, making your Markdown documentation more structured and user-friendly.
Related Posts
Blog Start Guide
Front-matter in Wan'er is a metadata section at the beginning of a Markdown file, enclosed between triple dashes (`---`). It provides essential information about the post and helps in categorization and rendering.
Lorem Ipsum 1
Lorem ipsum odor amet, consectetuer adipiscing elit. Odio tellus arcu aptent, non suscipit ex et.
Lorem Ipsum 2
Lorem ipsum odor amet, consectetuer adipiscing elit. Odio tellus arcu aptent, non suscipit ex et.