[Docu]: Admonitions Readme 1.0

[sigrunixia]

I am request a change on the...

• [X] Readme
• [ ] Publish Documentation

Located...

Entire Thing

The issue is...

It is Outdated now :)

In the case of needing more clarity, do you have any suggestions on what would make it clearer to you?

I have a write-up below. Of note, the final section does not specify TTRPG but instead suggests complementary plugins, which happens to be ttrpg plugins.

---

Writeup

---

🥇 Our documentation has moved here.

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. These blocks can be customized and styled to fit your specific needs, and can be easily added using the .callout and .admonition syntax. The plugin provides a range of pre-defined icons to choose from, as well as the ability to create your own custom styles using CSS.

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.
• It can be used 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. Preview your note to see the formatted admonition.

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, please 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:

• Obsidian Leaflet - Add interactive maps to Obsidian notes
• Dice Roller - Inline dice rolling for Obsidian
• Fantasy Statblocks - Format Statblocks inside Obsidian
• Initiative Tracker - Track initiative and turns in Obsidian

[sigrunixia]

Going to go ahead and add a few more tweaks and push this.