Custom Icons
Enhance your workspace with customizable icons for documents and folders.
[](https://github.com/RavenHogWarts/obsidian-custom-icons/releases/latest)
[中文](https://github.com/RavenHogWarts/obsidian-custom-icons/blob/master/README_ZH.md) | [English](README.md)
Usage
Currently, there are two ways to set the icons:
- Custom: This includes using online URLs, local relative or absolute file paths, Base64 encodings, or SVG tags.
- Lucide icons: This method requires only the name of the icon from Lucide. Note that the official Obsidian icons also use Lucide icons.
Examples
- Online URL:
https://www.example.com/favicon.ico - Local images:
- Relative path:
.obsidian/svg/example.svg - Absolute path (Unix-style):
/Users/YourUsername/Pictures/example.jpg - Absolute path (Windows-style):
D:\Pictures\example.png
- Relative path:
- Base64 encoding: Starting with
data: - SVG tags: Enclosed within
<svg></svg>tags - Lucide source icons: Directly use the icon name from Lucide.
Installation
Install from Community Plugins
Click to install, or:
- Open Obsidian and go to
Settings > Community Plugins. - Search for "Custom Icons".
- Click "Install".
Install via BRAT Plugin
- Install the BRAT plugin from Community Plugins.
- In the BRAT plugin settings, click "Add Beta Plugin".
- Enter the URL
https://github.com/RavenHogWarts/obsidian-custom-icons. - Enable "Custom Icons" in "Third-party Plugins".
Manual Installation
- Download the latest release from Releases.
- Copy
main.js,styles.cssandmanifest.jsontoVaultFolder/.obsidian/plugins/custom-sidebar-icons/. - Reload plugins and enable "Custom Icons" in "Third-party Plugins".
How to Build
- Clone the repository:
git clone https://github.com/RavenHogWarts/obsidian-custom-icons. - Install dependencies:
npm install. - Start development:
npm run dev. - Build for production:
npm run build.
License
Custom Icons is licensed under the MIT License. See LICENSE for more information.
Acknowledgements
Support
If you find this plugin useful and wish to support its development, you can do so through the following methods: WeChat, Alipay, Love Power Donation or Paypal. Any amount of support is appreciated. Thank you!
