README file from
GithubHighlights
- 1,474 icons in four sets. The Material Icon Theme's folders and file icons, everyday topic folders, and 406 brand-logo folders, all drawn in one consistent style.
- Matched automatically.
src,docs,images,.github,work,money,traveland a few thousand other folder names get the right icon with no setup. - Any icon, anywhere. A file can wear a folder icon or a logo, and a folder a file icon.
- Made to fit your theme. The icon takes the place of the one your theme draws instead of sitting beside it, and uses the Material Icon Theme's light variants in light mode.
- Private and offline. No network requests, no telemetry: every icon ships inside the plugin.
The picker
Right-click any folder or file → Change icon…, then search or pick from four tabs.
The picker opens on Folders for a folder and on Files for a file. The icon the theme would have
guessed from the name is shown first, badged match.
Install
From Community Plugins
Settings → Community plugins → Browse, search for Shard Icons, then Install and Enable. Or open the plugin page and it will take you there.
With BRAT
To follow releases the moment they are tagged:
- Install BRAT from Community Plugins.
- BRAT → Add beta plugin →
https://github.com/cachewraith/shard-icons. - Enable Shard Icons in Settings → Community plugins.
Manually
Download main.js, manifest.json and styles.css from the
latest release into
<your vault>/.obsidian/plugins/shard-icons/, then reload Obsidian.
Using it
- Change an icon — right-click a folder or file in the file explorer → Change icon…. Search, or switch tabs with the mouse; the arrow keys move through the grid, Enter picks and Esc closes.
- Reset one folder or file — right-click → Reset icon to default, or Reset to default in the dialog.
- From the keyboard — the commands Change icon of the active file and Change icon of the active file's folder open the same dialog for whatever note you are in.
- Automatic icons — folders you have not touched are matched by name; files can be matched by name and extension too, if you turn that on. An icon you chose yourself always wins.
- Renaming and moving keeps icons, including everything inside a folder. Deleting drops them.
Settings
| Setting | Default | What it does |
|---|---|---|
| Automatic folder icons | on | Folders with no chosen icon get one matched from their name |
| File icons | off | Files with no chosen icon get one from name and extension |
| Icon size | 16 px | Between 12 and 28 |
| Clear all custom icons | — | Asks first; cannot be undone |
Your data
Everything lives in .obsidian/plugins/shard-icons/data.json: your settings and which folder
or file has which icon. Nothing else is stored, and the plugin makes no network requests and
collects nothing.
An icon this version does not recognise — from a newer release, from a vault synced the other way, or a symbol icon from before 0.4.0 — shows as a plain folder or file and is kept, not deleted.
Contributing
Issues and pull requests are welcome. Building, testing and releasing are covered in
docs/: development and releasing.
Licenses
This plugin is MIT (see LICENSE). The icons it bundles are not:
- Material Icon Theme — MIT, © Philipp Kief and contributors.
licenses/material-icon-theme-LICENSE.txt - Simple Icons — CC0-1.0.
licenses/simple-icons-LICENSE.md - Material Design Icons — Apache-2.0, by Pictogrammers.
licenses/material-design-icons-LICENSE.txt
Brand logos are trademarks of their respective owners; the CC0 waiver covers the icon files,
not the marks. See licenses/ for the full notices.