Skip to content

Admonition plugin (Obsidian)

The Admonition plugin allows users to create styled callout blocks within Obsidian. This functionality enables the creation of distinct content boxes that can highlight specific information or organize notes visually^[obsidian.md].

Features

Admonition blocks support standard Markdown formatting, including bold text, [[wikilinks]], and file embeds^[obsidian.md]. Users can customize the appearance of these blocks by defining specific parameters, such as the title, collapsibility state, icon, and color^[obsidian.md].

Admonition types

The plugin supports a wide variety of types to categorize content^[obsidian.md]:

  • note
  • abstract, summary, tldr
  • info, todo
  • tip, hint, important
  • success, check, done
  • question, help, faq
  • warning, caution, attention
  • failure, fail, missing
  • danger, error
  • bug
  • example
  • quote, cite

Usage

In the Obsidian ecosystem, this functionality is often referred to as "obsidian-callouts"^[obsidian.md]. The plugin is utilized to create "框框樣式" (box styles) within notes^[obsidian.md].

Sources

^[obsidian.md]