Skip to content

Admonition plugin

The Admonition plugin (also referred to as obsidian-callouts or callouts) is a feature that allows users to create styled block content, often used for highlighting specific information such as notes, warnings, or summaries^[200-ob-000-obsidian.md]. It is listed as a core plugin within the [[Obsidian]] ecosystem under the category of "框框樣式" (frame style)^[200-ob-000-obsidian.md].

Callout Types

The plugin supports a variety of distinct types to categorize information^[200-ob-000-obsidian.md, 200-ob-plugin-admonition.md]:

  • Standard: note
  • Summaries: abstract, summary, tldr
  • Information: info, todo
  • Highlights: tip, hint, important
  • Confirmation: success, check, done
  • Inquiry: question, help, faq
  • Alerts: warning, caution, attention
  • Negative: failure, fail, missing
  • Critical: danger, error
  • Technical: bug
  • Illustrative: example
  • Reference: quote, cite

Syntax and Structure

Callouts can be created using either the native Callout Syntax or the syntax specific to the Admonition plugin^[200-ob-000-obsidian.md].

Native Callout Syntax

The basic structure involves defining the type and title within a blockquote^[200-ob-plugin-admonition.md].

> [!INFO] > Here's a callout block. 
> > It supports **markdown**, [wikilinks](Internal%20link), and [embeds](Embed%20files)! 
> ![](images/og-image.png)

Nested Callouts

The syntax supports nesting callouts within one another to create hierarchical information structures^[200-ob-plugin-admonition.md].

  • Nested Structure: Callouts can be placed inside other callouts. For example, a nested note can be placed inside a parent note^[200-ob-plugin-admonition.md].
  • Collapsible Nested Callouts: Nested elements can be made collapsible. For instance, a nested warning callout can be set to a closed state by default using the - modifier (e.g., > [!warning]-)^[200-ob-plugin-admonition.md].
  • Multiple Layers: It is possible to use multiple layers of nesting, for example, placing an example callout inside a todo callout, which is itself inside a question callout^[200-ob-plugin-admonition.md].

Plugin Specific Syntax

The specific Admonition plugin syntax offers additional configuration options through YAML frontmatter within the block^[200-ob-000-obsidian.md]:

```ad-<type>
title:                  # Admonition title.
collapse:               # Create a collapsible admonition.
icon:                   # Override the icon.
color:                  # Override the color.

Content...
```

Sources

^[200-ob-000-obsidian.md, 200-ob-plugin-admonition.md]