docs: theme config and list of theme templates (#116)
- Added theme configuration guide in README - Added some theme templates - Added list of theme templates in `themes/`
This commit is contained in:
@@ -266,7 +266,7 @@ end
|
|||||||
```
|
```
|
||||||
## Configuration guide
|
## Configuration guide
|
||||||
|
|
||||||
IRIS uses a clean TOML configuration file located at `~/.config/iris/config.toml`.
|
IRIS uses a clean TOML configuration file located at `~/.config/iris/config.toml`
|
||||||
|
|
||||||
### Creating & viewing config
|
### Creating & viewing config
|
||||||
|
|
||||||
@@ -365,8 +365,45 @@ timeout_ms = 5000
|
|||||||
😺 <i>Kitty terminal</i>
|
😺 <i>Kitty terminal</i>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
> [!TIP]
|
||||||
|
> **We keep all available theme templates in the `themes/` directory**
|
||||||
|
> **Feel free to create your own theme or contribute a new color scheme by adding it to this directory**
|
||||||
|
|
||||||
|
IRIS has theme TOML configuration file located at `~/.config/iris/theme.toml`
|
||||||
|
|
||||||
|
### Creating theme config
|
||||||
|
|
||||||
|
```bash
|
||||||
|
iris theme init
|
||||||
|
```
|
||||||
|
|
||||||
|
### Default theme
|
||||||
|
IRIS automatically falls back to the default theme if `theme.toml` is missing, empty, or contains missing configuration options
|
||||||
|
|
||||||
|
```toml
|
||||||
|
border = "#a277ff"
|
||||||
|
accent = "#61ffca"
|
||||||
|
muted = "#6d6a7f"
|
||||||
|
text = "#edecee"
|
||||||
|
text_sel = "#ffffff"
|
||||||
|
key = "#a277ff"
|
||||||
|
match = "#61ffca"
|
||||||
|
desc = "#9692a8"
|
||||||
|
desc_sel = "#edecee"
|
||||||
|
sel_bg = "#3d375e"
|
||||||
|
sel_text = "#110f18"
|
||||||
|
scroll_info = "#a277ff"
|
||||||
|
ghost_text = "#4B4A4C"
|
||||||
|
sys = "#1e1d28"
|
||||||
|
sys_sel = "#a277ff"
|
||||||
|
hist = "#1a2d36"
|
||||||
|
hist_sel = "#61ffca"
|
||||||
|
alias = "#2a2342"
|
||||||
|
alias_sel = "#a277ff"
|
||||||
|
```
|
||||||
|
|
||||||
> [!NOTE]
|
> [!NOTE]
|
||||||
> Currently, IRIS doesn't have custom theme but it does have 2 basic styles
|
> IRIS also has 2 basic styles
|
||||||
|
|
||||||
<table>
|
<table>
|
||||||
<tr>
|
<tr>
|
||||||
|
|||||||
@@ -0,0 +1,68 @@
|
|||||||
|
# Theme templates
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> This directory is reserved for theme templates only!
|
||||||
|
> When contributing, please:
|
||||||
|
> - Only add new color schemes
|
||||||
|
> - Do not add unrelated files
|
||||||
|
> - Check that the color scheme doesn't already exist before submitting
|
||||||
|
|
||||||
|
### [Gruvbox](./gruvbox.toml)
|
||||||
|
<table>
|
||||||
|
<td>
|
||||||
|
<img width="1357" height="411" alt="image" src="https://github.com/user-attachments/assets/97cfb7d7-e998-46a7-b714-2764da5df148" />
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<img width="1354" height="488" alt="image" src="https://github.com/user-attachments/assets/691f9eeb-7996-41dc-b2fe-fac1d2d23942" />
|
||||||
|
</td>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
### [Tokyo Night](./tokyo-night.toml)
|
||||||
|
<table>
|
||||||
|
<td>
|
||||||
|
<img width="1222" height="418" alt="image" src="https://github.com/user-attachments/assets/29d61d17-f1e2-4fd4-9cfe-403ba251d867" />
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<img width="1229" height="432" alt="image" src="https://github.com/user-attachments/assets/459f1794-2220-420f-9c4c-3db326b2c14d" />
|
||||||
|
</td>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
### [Catppuccin Mocha](./catppuccin-mocha.toml)
|
||||||
|
<table>
|
||||||
|
<td>
|
||||||
|
<img width="1283" height="414" alt="image" src="https://github.com/user-attachments/assets/01d9581b-cebe-4fac-870b-0fa52bd3398d" />
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<img width="1272" height="437" alt="image" src="https://github.com/user-attachments/assets/a2edcb00-6f40-4d49-bf63-9f4dac9a1f27" />
|
||||||
|
</td>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
### [Catppuccin Macchiato](./catppuccin-macchiato.toml)
|
||||||
|
<table>
|
||||||
|
<td>
|
||||||
|
<img width="1203" height="432" alt="image" src="https://github.com/user-attachments/assets/cabf1405-bd6b-47a8-a9b8-dfbf391944dd" />
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<img width="1259" height="445" alt="image" src="https://github.com/user-attachments/assets/e03aa500-a2c4-4c30-b839-62a4ca5e0e0d" />
|
||||||
|
</td>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
### [Catppuccin Frappé](./catppuccin-frappe.toml)
|
||||||
|
<table>
|
||||||
|
<td>
|
||||||
|
<img width="1219" height="437" alt="image" src="https://github.com/user-attachments/assets/4aa0daa8-56c4-4548-8cba-426a2561de70" />
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<img width="1200" height="437" alt="image" src="https://github.com/user-attachments/assets/feba0246-3cc7-466d-8f53-ff27e7601002" />
|
||||||
|
</td>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
### [Catppuccin Latte](./catppuccin-latte.toml)
|
||||||
|
<table>
|
||||||
|
<td>
|
||||||
|
<img width="1205" height="422" alt="image" src="https://github.com/user-attachments/assets/587810e7-6010-45f0-b7ca-f29da9fa8b28" />
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<img width="1203" height="421" alt="image" src="https://github.com/user-attachments/assets/49b4f397-b3a0-4a3b-84ae-56eb85a7096a" />
|
||||||
|
</td>
|
||||||
|
</table>
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
border = "#ca9ee6"
|
||||||
|
accent = "#81c8be"
|
||||||
|
muted = "#737994"
|
||||||
|
text = "#c6d0f5"
|
||||||
|
text_sel = "#c6d0f5"
|
||||||
|
key = "#ca9ee6"
|
||||||
|
match = "#a6d189"
|
||||||
|
desc = "#a5adce"
|
||||||
|
desc_sel = "#c6d0f5"
|
||||||
|
sel_bg = "#626880"
|
||||||
|
sel_text = "#303446"
|
||||||
|
scroll_info = "#ca9ee6"
|
||||||
|
ghost_text = "#626880"
|
||||||
|
sys = "#414559"
|
||||||
|
sys_sel = "#ef9f76"
|
||||||
|
hist = "#292c3c"
|
||||||
|
hist_sel = "#81c8be"
|
||||||
|
alias = "#414559"
|
||||||
|
alias_sel = "#ca9ee6"
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
border = "#eff1f5"
|
||||||
|
accent = "#179299"
|
||||||
|
muted = "#9ca0b0"
|
||||||
|
text = "#cdd6f4"
|
||||||
|
text_sel = "#4c4f69"
|
||||||
|
key = "#dc8a78"
|
||||||
|
match = "#179299"
|
||||||
|
desc = "#a6adc8"
|
||||||
|
desc_sel = "#4c4f69"
|
||||||
|
sel_bg = "#ccd0da"
|
||||||
|
sel_text = "#eff1f5"
|
||||||
|
scroll_info = "#dc8a78"
|
||||||
|
ghost_text = "#9ca0b0"
|
||||||
|
sys = "#24273a"
|
||||||
|
sys_sel = "#fe640b"
|
||||||
|
hist = "#e6e9ef"
|
||||||
|
hist_sel = "#179299"
|
||||||
|
alias = "#24273a"
|
||||||
|
alias_sel = "#ea76cb"
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
border = "#c6a0f6"
|
||||||
|
accent = "#8bd5ca"
|
||||||
|
muted = "#6e738d"
|
||||||
|
text = "#cad3f5"
|
||||||
|
text_sel = "#cad3f5"
|
||||||
|
key = "#c6a0f6"
|
||||||
|
match = "#a6da95"
|
||||||
|
desc = "#a5adcb"
|
||||||
|
desc_sel = "#cad3f5"
|
||||||
|
sel_bg = "#5b6078"
|
||||||
|
sel_text = "#24273a"
|
||||||
|
scroll_info = "#c6a0f6"
|
||||||
|
ghost_text = "#5b6078"
|
||||||
|
sys = "#363a4f"
|
||||||
|
sys_sel = "#f5a97f"
|
||||||
|
hist = "#1e2030"
|
||||||
|
hist_sel = "#8bd5ca"
|
||||||
|
alias = "#363a4f"
|
||||||
|
alias_sel = "#c6a0f6"
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
border = "#cba6f7"
|
||||||
|
accent = "#94e2d5"
|
||||||
|
muted = "#6c7086"
|
||||||
|
text = "#cdd6f4"
|
||||||
|
text_sel = "#cdd6f4"
|
||||||
|
key = "#cba6f7"
|
||||||
|
match = "#a6e3a1"
|
||||||
|
desc = "#a6adc8"
|
||||||
|
desc_sel = "#cdd6f4"
|
||||||
|
sel_bg = "#585b70"
|
||||||
|
sel_text = "#1e1e2e"
|
||||||
|
scroll_info = "#cba6f7"
|
||||||
|
ghost_text = "#585b70"
|
||||||
|
sys = "#313244"
|
||||||
|
sys_sel = "#fab387"
|
||||||
|
hist = "#181825"
|
||||||
|
hist_sel = "#94e2d5"
|
||||||
|
alias = "#313244"
|
||||||
|
alias_sel = "#cba6f7"
|
||||||
Reference in New Issue
Block a user