README file from
GithubMaterial File Tree Theme
A file tree theme that adds Material Icon Theme file and folder icons.
This plugin adapts the file and folder icon experience from the open-source material-extensions/vscode-material-icon-theme project for the file explorer.
Features
- No build step.
- No npm dependencies.
- Bundled Material-style SVG file and folder icons.
- Icon matching driven by the upstream
dist/material-icons.jsonmapping file. - Filename, compound extension, extension, language-id fallback, folder name, and expanded-folder name matching.
- Settings for icon size, opacity, grayscale, and file/folder toggles.
- A theme compatibility action that creates, enables, or removes a
neutral-file-treeCSS snippet for suppressing theme file-tree colors while keeping plugin icons.
Install locally
-
Create a folder in your vault:
<your-vault>/.obsidian/plugins/material-file-tree-theme/ -
Copy these files into that folder:
manifest.json main.js styles.css icons/ dist/material-icons.json LICENSE MATERIAL_ICON_THEME_LICENSE.txt README.md -
Go to
Settings -> Community plugins. -
Turn off restricted mode if needed.
-
Enable
Material File Tree Theme.
Icon resources
The community plugin installer downloads the plugin entry files, but it
may not install the large icons/ and dist/ resource folders. If the settings
page reports missing icon resources:
- Open the plugin settings.
- Click
Open download page. - Download
material-icon-souce.zipfrom the latest GitHub release. - Extract the zip.
- Click
Import folderand choose the extracted folder that containsicons/anddist/material-icons.json.
The plugin copies those resources into its vault plugin folder and reloads the file explorer icons automatically.
Release assets
Each GitHub release should include material-icon-souce.zip so users can import
the icon resources from the plugin settings page.
After creating a release for a tag, upload the resource pack:
scripts/release-resource-pack.sh <release-tag>
The script rebuilds material-icon-souce.zip from dist/ and icons/, then
uploads it to the release with gh release upload --clobber.
Attribution
The bundled SVG icons and dist/material-icons.json mapping are derived from
material-extensions/vscode-material-icon-theme,
which is licensed under the MIT License.
Keep MATERIAL_ICON_THEME_LICENSE.txt with this plugin when copying, sharing, or
redistributing the bundled icon assets.
License
This adapter code is released under the MIT License. See LICENSE.
The bundled Material Icon Theme assets retain their original MIT copyright notice.
See MATERIAL_ICON_THEME_LICENSE.txt.