Skip to content

Commit ee4781c

Browse files
committed
add theme docs
1 parent 9d73675 commit ee4781c

2 files changed

Lines changed: 54 additions & 1 deletion

File tree

‎docs/customize.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ elsewhere.
9696
This includes but is not limited to the following
9797

9898
- instantMENU
99-
- instantWM
99+
- instantWM — see [instantWM themes](/docs/wmsettings#themes)
100100
- Kitty
101101
- Sway
102102
- Hyprland

‎docs/wmsettings.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,59 @@ includes = [
2626

2727
Included files are merged into the main configuration. Paths can be absolute or relative to the main config file. Circular includes are detected and prevented.
2828

29+
## Themes
30+
31+
instantWM ships with several built-in colour themes that style the status bar,
32+
tags, window titles, borders and close buttons together. Set the top-level
33+
`theme` key to pick one:
34+
35+
```toml
36+
theme = "nord"
37+
```
38+
39+
That single line replaces the entire `[colors]` table — every colour is derived
40+
from the theme's palette. Themes are resolved when the config is read, so run
41+
`instantwmctl reload` (or restart instantWM) after changing `theme`.
42+
43+
### Built-in themes
44+
45+
| Name | Description |
46+
|------|-------------|
47+
| `instantos` | The default theme. Dark background with blue, green, yellow and red accents. |
48+
| `catppuccin-latte` | Light pastel theme (Catppuccin Latte). |
49+
| `catppuccin-frappe` | Dark, muted theme (Catppuccin Frappé). |
50+
| `catppuccin-macchiato` | Dark theme (Catppuccin Macchiato). |
51+
| `catppuccin-mocha` | Dark theme (Catppuccin Mocha). |
52+
| `nord` | Dark, cool-blue theme (Nord). |
53+
| `gruvbox` | Dark, warm earth-tone theme (Gruvbox). |
54+
55+
### Overriding theme colours
56+
57+
A theme is only the base. Anything you set under `[colors]` is merged on top of
58+
the selected theme, so you can keep a theme and tweak individual colours rather
59+
than redefining the whole palette:
60+
61+
```toml
62+
theme = "catppuccin-mocha"
63+
64+
# Keep the whole Mocha palette, but make the focused tiled-window
65+
# border pink instead of the theme's blue.
66+
[colors.border]
67+
tile_focus = "#f5c2e7"
68+
```
69+
70+
See [Color Schemes](#color-schemes) for every key you can override. Because a
71+
theme resolves to the same `[colors]` structure, you can also keep a theme
72+
choice (and any overrides) in its own file and pull it in with
73+
[includes](#config-includes).
74+
75+
:::warning
76+
An invalid theme name is a config parse error. instantWM logs a warning and
77+
falls back to the full default configuration, so the rest of the file is
78+
ignored until the name is fixed — double-check the spelling against the table
79+
above.
80+
:::
81+
2982
## Full Configuration Example
3083

3184
```toml

0 commit comments

Comments
 (0)