Skip to content

Obsidian Admonition plugin

Obsidian Admonition is a plugin for the Obsidian note-taking application that allows users to create stylized, collapsible callout blocks within their markdown notes^[600-developer-tools-obsidian-obsidian-admonition.md]. It is available on GitHub^[600-developer-tools-obsidian-obsidian-admonition.md].

Usage

Admonitions are created using code blocks that begin with ad- followed by a specific type identifier^[600-developer-tools-obsidian-obsidian-admonition.md].

Syntax

The basic syntax includes parameters for the title, collapsibility, icon, and color^[600-developer-tools-obsidian-obsidian-admonition.md]:

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

Example

For example, to create a standard note block^[600-developer-tools-obsidian-obsidian-admonition.md]:

```ad-note
title: Title
Lorem ipsum dolor sit amet.
```

Features

  • Types: The plugin supports various types such as note, question, and bug^[600-developer-tools-obsidian-obsidian-admonition.md].
  • Collapsible Content: Admonitions can be set to collapse: close to hide content by default, or collapse: open to have them expanded but collapsible^[600-developer-tools-obsidian-obsidian-admonition.md].
  • Nesting: Admonitions can be nested inside one another^[600-developer-tools-obsidian-obsidian-admonition.md].

Sources

  • 600-developer-tools-obsidian-obsidian-admonition.md