Skip to content

Admonition types

Admonition types are keywords used within the Obsidian Admonition plugin to style content blocks distinctly, allowing users to create visually appealing and organized notes.^[600-developer__tools__obsidian__Obsidian-admonition.md]

Syntax

To create an admonition, a code block is initiated with the syntax ad-<type>, where <type> determines the visual style and icon of the block.^[600-developer__tools__obsidian__Obsidian-admonition.md]

Standard metadata keys supported by these types include:

  • title: Sets the header of the admonition block.^[600-developer__tools__obsidian__Obsidian-admonition.md]
  • collapse: Creates a collapsible admonition (options include open or close).^[600-developer__tools__obsidian__Obsidian-admonition.md]
  • icon: Overrides the default icon associated with the type.^[600-developer__tools__obsidian__Obsidian-admonition.md]
  • color: Overrides the default color scheme.^[600-developer__tools__obsidian__Obsidian-admonition.md]

Common Types

The plugin supports a variety of types to signify different content categories:

  • Note: Used for general information or comments.^[600-developer__tools__obsidian__Obsidian-admonition.md]
  • Question: Suitable for posing questions or quizzes.^[600-developer__tools__obsidian__Obsidian-admonition.md]
  • Bug: Designed for highlighting software defects or issues.^[600-developer__tools__obsidian__Obsidian-admonition.md]

Advanced Features

Admonition blocks support nested structures, allowing one admonition type (such as a note) to contain another admonition type (like a warning or another note) inside it.^[600-developer__tools__obsidian__Obsidian-admonition.md]

Sources

  • 600-developer__tools__obsidian__Obsidian-admonition.md