https://github.com/FlorianWoelki/obsidian-iconize

Simply add icons to anything you want in Obsidian.
https://github.com/FlorianWoelki/obsidian-iconize

icons obsidian obsidian-community obsidian-folder obsidian-iconize obsidian-icons obsidian-md obsidian-plugin

Last synced: about 1 month ago
JSON representation

Simply add icons to anything you want in Obsidian.

• Host: GitHub
• URL: https://github.com/FlorianWoelki/obsidian-iconize
• Owner: FlorianWoelki
• License: mit
• Created: 2021-08-27T13:39:33.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-13T08:56:04.000Z (5 months ago)
• Last Synced: 2024-04-13T21:10:08.596Z (5 months ago)
• Topics: icons, obsidian, obsidian-community, obsidian-folder, obsidian-iconize, obsidian-icons, obsidian-md, obsidian-plugin
• Language: TypeScript
• Homepage: https://florianwoelki.github.io/obsidian-iconize/
• Size: 8.53 MB
• Stars: 674
• Watchers: 7
• Forks: 48
• Open Issues: 92
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• project-awesome - FlorianWoelki/obsidian-iconize - Simply add icons to anything you want in Obsidian. (TypeScript)
• jimsghstars - FlorianWoelki/obsidian-iconize - Simply add icons to anything you want in Obsidian. (TypeScript)

README

        
# Obsidian Iconize

![Preview Image](./docs/preview-image.png)

## What is it?

This obsidian plugin allows you to add **any** custom icon (of type `.svg`) or from an icon pack to anything you want.

Refer to the official documentation for more information:

[https://florianwoelki.github.io/obsidian-iconize/](https://florianwoelki.github.io/obsidian-iconize/) about the plugin and its functionalities.

If you like this plugin, feel free to support the development by buying a coffee:



## Key Highlights

[Icons before file/folder name](https://florianwoelki.github.io/obsidian-iconize/files-and-folders/icon-before-file-or-folder.html),

[Icons in notes](https://florianwoelki.github.io/obsidian-iconize/notes/icons-in-notes.html),

[Icon above title](https://florianwoelki.github.io/obsidian-iconize/notes/title-icon.html),

[Predefined icon packs](https://florianwoelki.github.io/obsidian-iconize/guide/icon-packs.html),

[Icons in tabs](https://florianwoelki.github.io/obsidian-iconize/files-and-folders/icon-tabs.html),

[Customizable settings](https://florianwoelki.github.io/obsidian-iconize/guide/settings.html),

[Custom rules](https://florianwoelki.github.io/obsidian-iconize/files-and-folders/custom-rules.html),

[Frontmatter integration](https://florianwoelki.github.io/obsidian-iconize/files-and-folders/use-frontmatter.html),

[Change color of an individual icon](https://florianwoelki.github.io/obsidian-iconize/files-and-folders/individual-icon-color.html),

## Development

To customize this project for your needs, you can clone it and then install all dependencies:

```sh

$ git clone https://github.com/FlorianWoelki/obsidian-iconize

$ cd obsidian-iconize

$ pnpm i

```

After the installation, you need to create a `env.js` file in the root directory. Fill the file with the following content:

```js

export const obsidianExportPath =

  '/.obsidian/plugins/obsidian-iconize/';

```

Make sure you create the directory specified in that variable if it does not exist yet.

Afterwards, you can start the rollup dev server by using:

```sh

$ pnpm dev

```

This command will automatically build the neccesary files for testing and developing on every change. Furthermore, it does copy all the necessary files to the plugin directory you specified.

Finally, you can customize the plugin and add it to your plugins.