Convert Figma logo to code with AI

javalent logoadmonitions

Adds admonition block-styled content to Obsidian.md

1,185
78
1,185
18

Top Related Projects

Adds admonition block-styled content to Obsidian.md

Create markdown-backed Kanban boards in Obsidian.

A data index and query language over Markdown files, for https://obsidian.md/.

A template plugin for obsidian

A dynamic user interface for adjusting theme, plugin, and snippet CSS variables within Obsidian

Quick Overview

The javalent/admonitions repository is a plugin for Obsidian, a popular note-taking application. It enhances Obsidian's functionality by providing customizable admonition blocks, which are visually distinct sections in notes used to highlight important information, warnings, or tips.

Pros

  • Highly customizable, allowing users to create their own admonition types and styles
  • Supports nested admonitions for complex information hierarchies
  • Integrates seamlessly with Obsidian's markdown syntax
  • Regular updates and active community support

Cons

  • May require some initial setup and configuration for optimal use
  • Learning curve for users unfamiliar with custom CSS and admonition syntax
  • Potential performance impact on large documents with many admonitions
  • Limited use outside of the Obsidian ecosystem

Getting Started

To use the Admonitions plugin in Obsidian:

  1. Open Obsidian and go to Settings > Community Plugins
  2. Disable Safe Mode if enabled
  3. Click "Browse" and search for "Admonition"
  4. Install the plugin and enable it

Basic usage in your Obsidian notes:

```ad-note
This is a basic admonition block
title: Custom Title
This is a warning with a custom title
collapse: true
This is a collapsible info block

Customize admonitions in the plugin settings or by adding custom CSS to your Obsidian vault.

Competitor Comparisons

Adds admonition block-styled content to Obsidian.md

Pros of admonitions

  • More actively maintained with recent updates
  • Larger community and user base
  • Extensive documentation and examples

Cons of admonitions

  • May have more complexity due to additional features
  • Potentially higher resource usage

Code comparison

admonitions:

export default class AdmonitionPlugin extends Plugin {
  async onload() {
    this.registerMarkdownCodeBlockProcessor("ad", (source, el, ctx) => {
      const admonition = createAdmonition(source, el, ctx);
      el.replaceWith(admonition);
    });
  }
}

admonitions>:

// No relevant code comparison available

Note: The repository javalent/admonitions> does not exist or is not publicly accessible. The comparison provided is based on the assumption that javalent/admonitions> is a different version or fork of javalent/admonitions. Without access to the actual repository, a meaningful code comparison cannot be made.

The admonitions plugin appears to be a well-established and feature-rich solution for creating admonitions in Markdown documents. It offers robust functionality and community support. However, without access to the admonitions> repository, it's challenging to provide a comprehensive comparison of their features, advantages, or disadvantages.

Create markdown-backed Kanban boards in Obsidian.

Pros of Kanban

  • Provides a visual board interface for task management
  • Allows drag-and-drop functionality for easy task organization
  • Supports multiple boards and lanes for complex project management

Cons of Kanban

  • Limited customization options for admonition-style content blocks
  • Requires more setup and configuration compared to simple admonitions
  • May be overkill for users who only need basic note formatting

Code Comparison

Kanban board creation:

const board = new KanbanBoard({
  lanes: ['To Do', 'In Progress', 'Done'],
  tasks: [{ title: 'Task 1', lane: 'To Do' }]
});

Admonition creation:

const admonition = new Admonition({
  type: 'note',
  title: 'Important',
  content: 'This is a crucial piece of information.'
});

Summary

Kanban is better suited for project management and task tracking, offering a visual board interface with drag-and-drop functionality. Admonitions, on the other hand, excel at creating simple, customizable content blocks for note-taking and documentation. The choice between the two depends on the user's specific needs for organization and formatting within Obsidian.

A data index and query language over Markdown files, for https://obsidian.md/.

Pros of Dataview

  • Powerful querying capabilities for Obsidian notes
  • Supports multiple output formats (lists, tables, tasks)
  • Extensive documentation and active community support

Cons of Dataview

  • Steeper learning curve due to its query language
  • Can be resource-intensive for large vaults
  • Requires manual data entry or frontmatter for optimal use

Code Comparison

Dataview query example:

TABLE file.ctime AS "Created", file.mtime AS "Modified"
FROM "Projects"
SORT file.mtime DESC

Admonitions example:

```ad-note
title: Project Status
color: 204, 82, 0

Project started on [[2023-05-01]]
Last updated: [[2023-05-15]]

### Key Differences

- Admonitions focuses on visual note enhancements and callouts
- Dataview specializes in data querying and dynamic content generation
- Admonitions is more user-friendly for beginners
- Dataview offers more advanced data manipulation features

### Use Cases

- Admonitions: Ideal for creating visually appealing notes with custom callouts
- Dataview: Best for users who need to query and analyze data across their vault

### Community and Support

Both plugins have active communities and regular updates, but Dataview has a larger user base and more extensive third-party resources available.

A template plugin for obsidian

Pros of Templater

  • More versatile, allowing for complex templating and scripting beyond just admonitions
  • Supports JavaScript for advanced customization and automation
  • Integrates with external scripts and system commands for extended functionality

Cons of Templater

  • Steeper learning curve due to its broader feature set
  • May be overkill for users only interested in simple admonitions
  • Requires more setup and configuration for basic use cases

Code Comparison

Templater (JavaScript-based templating):

<%*
let title = tp.file.title
let date = tp.date.now("YYYY-MM-DD")
-%>
# <%= title %>
Created: <%= date %>

Admonitions (Markdown-based admonitions):

```ad-note
title: Important Note
This is a simple admonition block.

### Summary

Templater offers more powerful templating and scripting capabilities, making it suitable for users who need advanced automation and customization in their Obsidian workflows. Admonitions, on the other hand, focuses specifically on creating visually appealing callout blocks with a simpler syntax, making it more accessible for users primarily interested in enhancing their note-taking with formatted admonitions.

A dynamic user interface for adjusting theme, plugin, and snippet CSS variables within Obsidian

Pros of Style Settings

  • Provides a user-friendly interface for customizing CSS variables
  • Allows for easy creation of theme settings without coding knowledge
  • Supports a wide range of input types (text, number, select, etc.)

Cons of Style Settings

  • Limited to modifying existing CSS variables
  • Requires themes to be specifically designed for use with the plugin
  • May not offer as much flexibility for advanced customizations

Code Comparison

Style Settings:

{
  "name": "Accent color",
  "id": "accentColor",
  "type": "variable-color",
  "format": "hex",
  "default": "#007AFF"
}

Admonitions:

type: note
title: Note
color: 0, 184, 212
icon: lucide-pencil

Summary

Style Settings focuses on providing a user-friendly interface for customizing theme appearance through CSS variables, while Admonitions is specifically designed for creating and managing custom callouts or admonition blocks in Obsidian notes. Style Settings offers easier customization for non-technical users, but may be less flexible for advanced modifications. Admonitions provides more specialized functionality for enhancing note-taking with visually distinct blocks of content.

Convert Figma logo designs to code with AI

Visual Copilot

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot

README

🥇 Our documentation has moved here.

Buy Me a Coffee at ko-fi.com


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