mirror of
https://github.com/lsd-rs/lsd
synced 2024-12-15 06:22:47 +00:00
📝 🔨 refine icon theme description
Co-authored-by: Abin Simon <abinsimon10@gmail.com>
This commit is contained in:
parent
38fc385129
commit
501232dbe2
1 changed files with 4 additions and 54 deletions
58
README.md
58
README.md
|
@ -311,54 +311,11 @@ Check [Icon Theme file content](#icon-theme-file-content) for details.
|
||||||
|
|
||||||
#### Icon Theme file content
|
#### Icon Theme file content
|
||||||
|
|
||||||
lsd support 3 kinds of icon configuration:
|
`lsd` support 3 kinds of icon overrides, by `name`, by `filetype` and by `extension`.
|
||||||
- filetype
|
The final set of icons used will be a combination of what is shipped with in `lsd` with overrides from config applied on top of it.
|
||||||
- name
|
*You can find the default set of icons [here](src/theme/icon.rs).*
|
||||||
- extension
|
|
||||||
|
|
||||||
The default icon theme scheme shipped with `lsd` can be check in [icon theme source code](src/theme/icon.rs), we will load the default theme, and overwrite it with user defined parts, here is a example for icon theme.
|
Both nerd font glyphs and unicode emojis can be used for icons. You can find an example of icons customization below.
|
||||||
|
|
||||||
lsd icon theme support both nerd font and Unicode in the same time, you can use any one to config the theme, this is the default but you can customize this to use glyphs from nerd-font or Unicode emojis in the same time.
|
|
||||||
|
|
||||||
nerd font:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
name:
|
|
||||||
.trash:
|
|
||||||
.cargo:
|
|
||||||
.emacs.d:
|
|
||||||
a.out:
|
|
||||||
extension:
|
|
||||||
go:
|
|
||||||
hs:
|
|
||||||
rs:
|
|
||||||
filetype:
|
|
||||||
dir:
|
|
||||||
file:
|
|
||||||
pipe:
|
|
||||||
socket:
|
|
||||||
executable:
|
|
||||||
symlink-dir:
|
|
||||||
symlink-file:
|
|
||||||
device-char:
|
|
||||||
device-block: ﰩ
|
|
||||||
special:
|
|
||||||
```
|
|
||||||
|
|
||||||
Unicode:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
name:
|
|
||||||
.trash: 🗑
|
|
||||||
extension:
|
|
||||||
rs: 🦀
|
|
||||||
filetype:
|
|
||||||
dir: 📂
|
|
||||||
file: 📄
|
|
||||||
pipe: 📩
|
|
||||||
```
|
|
||||||
|
|
||||||
mixed:
|
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
name:
|
name:
|
||||||
|
@ -374,9 +331,6 @@ filetype:
|
||||||
dir: 📂
|
dir: 📂
|
||||||
file: 📄
|
file: 📄
|
||||||
pipe: 📩
|
pipe: 📩
|
||||||
dir:
|
|
||||||
file:
|
|
||||||
pipe:
|
|
||||||
socket:
|
socket:
|
||||||
executable:
|
executable:
|
||||||
symlink-dir:
|
symlink-dir:
|
||||||
|
@ -384,10 +338,6 @@ filetype:
|
||||||
device-char:
|
device-char:
|
||||||
device-block: ﰩ
|
device-block: ﰩ
|
||||||
special:
|
special:
|
||||||
```
|
|
||||||
|
|
||||||
When creating a theme for `lsd`, you can specify any part of the default theme,
|
|
||||||
and then change its icons, the items missed would fallback to use the default icons.
|
|
||||||
|
|
||||||
## External Configurations
|
## External Configurations
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue