MCPcopy Index your code
hub / github.com/ebullient/obsidian-admonition

github.com/ebullient/obsidian-admonition @12.0.5

Chat with this repo
repository ↗ · DeepWiki ↗ · release 12.0.5 ↗ · + Follow
156 symbols 344 edges 50 files 1 documented · 1%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

Admonition

The Admonition plugin for Obsidian is a tool that allows you to create attention-grabbing callouts, tips, warnings and other informative blocks within your notes. The plugin provides a range of pre-defined icons to pick from, as well as the ability to create your own custom styles using CSS. You can customize and style to fit your specific needs, and can target each iteration independently using the .callout and .admonition selectors.

Features

  • Supports a variety of built-in admonition types such as tip, warning, caution, note, and more.
  • Customizable styles with the ability to use Markdown attributes in callouts, or stylize directly with CSS.
  • Supports nesting of blockquotes and code-blocks.
  • Admonitions can flourish in combination with other plugins such as Obsidian Templates or @SilentVoid13's Templater.
  • Supports import and export of custom admonitions via .json files.

Quickstart

  1. Install the Admonition plugin from the Community Plugins pane in Obsidian.
  2. Callout Version: In the editor, type out the name of an admonition type (such as >[!tip]) followed by your content.
  3. Admonition Version: In the editor, type out the name of an admonition type in a code block (such as ```ad-tip) followed by your content on the subsequent lines.
  4. Ensure three backticks close your codeblock.
  5. Preview your note to see the formatted admonition.
```ad-tip
title: This is a tip

This is the content of the admonition tip.
```

Check out the plugin documentation for more detailed instructions and examples.

Support

If you encounter any issues, want to give back and help out, or have suggestions for new features, file an issue on the GitHub repository.

Complementary Plugins by Javalent

While we think all of our plugins are pretty awesome, we think these are especially awesome and work well with this plugin:

Extension points exported contracts — how you extend this code

AbstractInputSuggest (Interface)
(no doc) [2 implementers]
src/modal/suggester.ts
App (Interface)
(no doc)
src/main.ts
Editor (Interface)
(no doc)
src/@types/codemirror.d.ts
MarkdownPreviewView (Interface)
(no doc)
src/main.ts
Window (Interface)
(no doc)
src/@types/codemirror.d.ts
MarkdownPreviewRenderer (Interface)
(no doc)
src/main.ts
Admonition (Interface)
(no doc)
src/@types/index.d.ts
Editor (Interface)
(no doc)
src/main.ts

Core symbols most depended-on inside this repo

t9n
called by 78
src/lang/helpers.ts
OB
called by 28
src/util/constants.ts
saveSettings
called by 15
src/main.ts
getIconNode
called by 7
src/icons/manager.ts
isIconWithCss
called by 6
src/main.ts
shouldInjectColor
called by 6
src/main.ts
downloadIcon
called by 5
src/main.ts
validateType
called by 5
src/util/validator.ts

Shape

Method 93
Class 26
Function 26
Interface 11

Languages

TypeScript100%

Modules by API surface

src/main.ts31 symbols
src/modal/index.ts17 symbols
src/callout/manager.ts17 symbols
src/settings.ts14 symbols
src/suggest/suggest.ts13 symbols
src/modal/callout.ts13 symbols
src/icons/manager.ts13 symbols
src/modal/suggester.ts7 symbols
src/modal/confirm.ts6 symbols
src/modal/export.ts5 symbols
src/util/validator.ts4 symbols
src/@types/codemirror.d.ts4 symbols

For agents

$ claude mcp add obsidian-admonition \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page