Home

Awesome

Obsidian Icons Plugin

Obsidian Icons Plugin

Note:: Please report any bugs you encounter by opening a new issue on GitHub.

Add icons to your Obsidian notes. Supported icon sets:

You can toggle which icon set(s) you want to display in the icon picker from within the Icons Plugin settings.

This plugin uses react-icons to render icons via a Markdown postprocessor. Inspired by obsidian-citation-plugin and based on obsidian-sample-plugin.

Demo and Screenshots

Demonstration

A demonstration video showing the icon picker and the rendered markdown.

Screenshot Picker

Select any icon from the icon picker (selectively activate icon packs in the settings).

Screenshot Rendered

The rendered markdown will display the icons accordingly.

How to report bugs

As this is an experimental plugin, bugs are expected to occur. Kindly open an issue in this repository and describe in detail what bug you encountered.

Icon Sets and Licenses

Icon SetLicenseVersionCount
Font AwesomeCC BY 4.0 License5.12.11560
Remix IconApache License Version 2.02.5.02172

Customizing Icons

In order to customize the icons in order to change their color, size, etc, you should make a CSS snippet.

To do this, follow these steps:

  1. Go to Settings -> Appearance -> CSS Snippets
  2. Turn on the CSS Snippets option and then click the folder to navigate to it's folder.
  3. Make a new file called icons.css
  4. Open icons.css in your preferred text editor
  5. Add the following:
    .obsidian-icon {
    	... changes go here.
    }
    
  6. Go Back to Settings -> Appearance -> CSS Snippets
  7. Click the reload button
  8. A button with the title "icons" should appear, turn it on.

Your changes will now be applied and you can edit the file when you want.

Development

How to develop

Releasing new releases

Manually installing the plugin

API Documentation

See https://github.com/obsidianmd/obsidian-api