Skip to content

Callout Syntax

Callout Syntax is a markdown-based feature used in note-taking applications like [[Obsidian]] to create distinct, styled content blocks.^[200-ob-plugin-admonition.md]

Supported Types

The syntax supports a variety of specific types, each corresponding to different colors or icons in the user interface^[200-ob-plugin-admonition.md]:

  • Note: The default standard callout.
  • Abstract, Summary, Tldr: Used for summaries.
  • Info, Todo: For information or tasks.
  • Tip, Hint, Important: For helpful suggestions.
  • Success, Check, Done: To indicate completion or success.
  • Question, Help, Faq: For queries or help sections.
  • Warning, Caution, Attention: To highlight warnings.
  • Failure, Fail, Missing: To indicate failure or missing items.
  • Danger, Error: For critical errors or dangers.
  • Bug: To flag software bugs.
  • Example: For providing examples.
  • Quote, Cite: For citations or quotations.

Structure and Nesting

Callouts follow a block quote syntax pattern, initiated by a specific type identifier^[200-ob-plugin-admonition.md]. The basic structure for a generic callout uses the format > [!type]. For example, a failure block is created like this:

[!fail] Lorem ipsum dolor sit amet^[200-ob-plugin-admonition.md]

Callouts can be nested to create hierarchical structures within a note^[200-ob-plugin-admonition.md]. Nested blocks are created by inserting a new callout block inside a parent callout, visually indenting the content^[200-ob-plugin-admonition.md].

Folding and Expanded States

Callouts support different fold states to control visibility^[200-ob-plugin-admonition.md]:

  • Expanded (Default): Adding a + after the type identifier (e.g., > [!note]+) forces the callout to remain open by default^[200-ob-plugin-admonition.md].
  • Collapsed: Adding a - after the type identifier (e.g., > [!warning]-) creates a callout that is closed by default^[200-ob-plugin-admonition.md].

Sources

^[200-ob-plugin-admonition.md]