Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docu]: Admonitions Readme 1.0 #302

Closed
1 of 2 tasks
sigrunixia opened this issue Apr 25, 2023 · 1 comment · Fixed by #307 or #304
Closed
1 of 2 tasks

[Docu]: Admonitions Readme 1.0 #302

sigrunixia opened this issue Apr 25, 2023 · 1 comment · Fixed by #307 or #304
Assignees

Comments

@sigrunixia
Copy link
Member

I am request a change on the...

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.

Buy Me a Coffee at ko-fi.com


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:

@sigrunixia
Copy link
Member Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants