Marshall Bowers
bf21d9183e
This PR updates the icon theme docs with examples of `file_stems` and `file_suffixes` that were added in https://github.com/zed-industries/zed/pull/24926. Release Notes: - N/A
73 lines
2.0 KiB
Markdown
73 lines
2.0 KiB
Markdown
# Icon Themes
|
|
|
|
Extensions may provide icon themes in order to change the icons Zed uses for folders and files.
|
|
|
|
## Example extension
|
|
|
|
The [Material Icon Theme](https://github.com/zed-extensions/material-icon-theme) serves as an example for the structure of an extension containing an icon theme.
|
|
|
|
## Directory structure
|
|
|
|
There are two important directories for an icon theme extension:
|
|
|
|
- `icon_themes`: This directory will contain one or more JSON files containing the icon theme definitions.
|
|
- `icons`: This directory contains the icons assets that will be distributed with the extension. You can created subdirectories in this directory, if so desired.
|
|
|
|
Each icon theme file should adhere to the JSON schema specified at [`https://zed.dev/schema/icon_themes/v0.2.0.json`](https://zed.dev/schema/icon_themes/v0.2.0.json).
|
|
|
|
Here is an example of the structure of an icon theme:
|
|
|
|
```json
|
|
{
|
|
"$schema": "https://zed.dev/schema/icon_themes/v0.2.0.json",
|
|
"name": "My Icon Theme",
|
|
"author": "Your Name",
|
|
"themes": [
|
|
{
|
|
"name": "My Icon Theme",
|
|
"appearance": "dark",
|
|
"directory_icons": {
|
|
"collapsed": "./icons/folder.svg",
|
|
"expanded": "./icons/folder-open.svg"
|
|
},
|
|
"chevron_icons": {
|
|
"collapsed": "./icons/chevron-right.svg",
|
|
"expanded": "./icons/chevron-down.svg"
|
|
},
|
|
"file_stems": {
|
|
"Makefile": "make"
|
|
},
|
|
"file_suffixes": {
|
|
"mp3": "audio",
|
|
"rs": "rust"
|
|
},
|
|
"file_icons": {
|
|
"audio": { "path": "./icons/audio.svg" },
|
|
"default": { "path": "./icons/file.svg" },
|
|
"make": { "path": "./icons/make.svg" },
|
|
"rust": { "path": "./icons/rust.svg" }
|
|
// ...
|
|
}
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
Each icon path is resolved relative to the root of the extension directory.
|
|
|
|
In this example, the extension would have a structure like so:
|
|
|
|
```
|
|
extension.toml
|
|
icon_themes/
|
|
my-icon-theme.json
|
|
icons/
|
|
audio.svg
|
|
chevron-down.svg
|
|
chevron-right.svg
|
|
file.svg
|
|
folder-open.svg
|
|
folder.svg
|
|
rust.svg
|
|
```
|