https://github.com/javalent/admonitions

Adds admonition block-styled content to Obsidian.md
https://github.com/javalent/admonitions

obsidian-plugin

Last synced: about 2 months ago
JSON representation

Adds admonition block-styled content to Obsidian.md

• Host: GitHub
• URL: https://github.com/javalent/admonitions
• Owner: javalent
• License: mit
• Created: 2021-03-17T17:47:18.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-06-17T07:41:43.000Z (3 months ago)
• Last Synced: 2024-07-27T12:26:31.330Z (about 2 months ago)
• Topics: obsidian-plugin
• Language: TypeScript
• Homepage:
• Size: 5.83 MB
• Stars: 1,048
• Watchers: 5
• Forks: 67
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
> 🥇 Our documentation has moved ***[here](https://plugins.javalent.com/admonitions)***.

>

> 

>

> ---

> 

> **Development Status**: Maintenance Mode

> 

> Due to a glut of high priority Javalent plugin projects, this plugin is now entering maintenance mode for the time being. This is **not** a permanent status.

> - PR's will be reviewed.

> - *Yay* bugs will be reviewed and worked if able.

> - Feature Requests **will not** be worked.

---

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](https://help.obsidian.md/Plugins/Templates)** or @SilentVoid13's **[Templater](https://github.com/SilentVoid13/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.

````yaml

```ad-tip

title: This is a tip

This is the content of the admonition tip.

```

````

Check out the **[plugin documentation](https://plugins.javalent.com/admonitions)** 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](https://github.com/javalent/admonitions/issues)**.

### 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](https://github.com/valentine195/obsidian-leaflet-plugin)** Adds interactive maps to Obsidian notes

- **[Dice Roller](https://github.com/valentine195/obsidian-dice-roller)** Inline dice rolling for Obsidian

- **[Fantasy Statblocks](https://github.com/valentine195/obsidian-5e-statblocks)** Format Statblocks inside Obsidian

- **[Initiative Tracker](https://github.com/valentine195/obsidian-initiative-tracker)** Track initiative and turns in Obsidian