Skip to content

Commit 79c0086

Browse files
update changelog and freeze website docs version for 0.9.0
1 parent 86e8be9 commit 79c0086

31 files changed

Lines changed: 3010 additions & 2 deletions

CHANGELOG.md

Lines changed: 200 additions & 0 deletions
Large diffs are not rendered by default.

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ homepage = "https://malpenzibo.github.io/ashell/"
55
repository = "https://github.com/MalpenZibo/ashell"
66
authors = ["Simone Camito (Zibo)"]
77
license = "GPL-3.0-or-later"
8-
version = "0.8.0"
8+
version = "0.9.0"
99
edition = "2024"
1010
rust-version = "1.89"
1111

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
position: 3
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
position: 3
Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# General
6+
7+
These are all the appearance options not related to the color palette.
8+
9+
## Font
10+
11+
You can change the font used by setting the `font_name` field. This configuration
12+
is optional—if not set, the `iced` library will use the default font.
13+
14+
```toml
15+
[appearance]
16+
font_name = "Comic Sans MS"
17+
```
18+
19+
:::warning
20+
21+
Changing the font requires killing and restarting ashell process. The font configuration does not support hot-reloading
22+
23+
:::
24+
25+
## Scaling Factor
26+
27+
You can change the scaling factor of the status bar using the `scale_factor` field.
28+
29+
The value should be a float greater than `0.0` and less than or equal to `2.0`.
30+
The default value is `1.0`.
31+
32+
```toml
33+
[appearance]
34+
scale_factor = 1.5
35+
```
36+
37+
## Status Bar Style
38+
39+
You can change the style of the status bar using the `style` field.
40+
41+
You can choose between:
42+
43+
- `Islands`: This is the default style. Each module or module group is displayed
44+
in a rounded rectangle using the background color.
45+
- `Solid`: The status bar has a solid background color.
46+
- `Gradient`: The status bar has a gradient background color.
47+
48+
### Example
49+
50+
```toml
51+
[appearance]
52+
style = "Gradient"
53+
```
54+
55+
## Opacity
56+
57+
You can change the opacity of the status bar components using the `opacity` field.
58+
59+
The value should be a float between `0.0` and `1.0`, where `0.0` is fully transparent.
60+
The default value is `1.0`.
61+
62+
It's also possible to define the opacity of status bar menus and whether they should
63+
include a backdrop effect.
64+
65+
The `backdrop` effect adds a blur/transparent background to menus, making them appear
66+
semi-transparent over the content behind them. The value should be a float between `0.0`
67+
and `1.0`, where `0.0` disables the effect and `1.0` applies maximum blur.
68+
69+
**Default values:**
70+
71+
- `opacity`: `1.0` (fully opaque)
72+
- `menu.opacity`: `1.0` (fully opaque)
73+
- `menu.backdrop`: `0.0` (disabled)
74+
75+
## Examples
76+
77+
Setting the opacity of the status bar components:
78+
79+
```toml
80+
[appearance]
81+
opacity = 0.8
82+
```
83+
84+
Also setting the opacity of the status bar menus and adding a backdrop effect:
85+
86+
```toml
87+
[appearance]
88+
opacity = 0.8
89+
90+
[appearance.menu]
91+
opacity = 0.7
92+
backdrop = 0.3
93+
```
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# 🎨 Appearance
2+
3+
With these configurations, you can change the appearance of ashell.
4+
5+
It's possible to modify the color palette and other general visual aspects.
6+
7+
All of these configurations should be placed in the `appearance` section
8+
of the configuration file.
9+
10+
You can customize things like:
11+
12+
- The color palette
13+
- The font used
14+
- The scaling factor of the status bar
15+
- The style of the status bar
16+
- The opacity of the status bar components
17+
- The opacity of the status bar menus
Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# Palette
6+
7+
With these configuration options, you can customize
8+
the color palette of your status bar.
9+
10+
## Color Syntax
11+
12+
Each color can be specified as a simple hex color or as an object with variants.
13+
14+
### Simple Syntax
15+
16+
```toml
17+
primary_color = "#7aa2f7"
18+
```
19+
20+
### Advanced Syntax
21+
22+
```toml
23+
[appearance.primary_color]
24+
base = "#7aa2f7"
25+
strong = "#8aacff"
26+
weak = "#6988e6"
27+
text = "#1a1b26"
28+
```
29+
30+
All fields except `base` are optional. If not provided, they are
31+
auto-generated from the base color:
32+
33+
- **`weak`**: The base color faded toward the background. Used for subtle,
34+
de-emphasized states (e.g. hover backgrounds, inactive elements).
35+
- **`strong`**: The base color pushed away from the background for more
36+
contrast. Used for emphasized, active states.
37+
- **`text`**: The text color to use on top of this color. If not provided,
38+
the default text color is used (with automatic contrast adjustment).
39+
40+
## Palette Colors
41+
42+
| Color | Description |
43+
|-------|-------------|
44+
| `background_color` | Background color for all status bar components |
45+
| `primary_color` | Accent color for interactive elements (buttons, slider handles, active states) |
46+
| `success_color` | Positive feedback indicators (e.g. connected, active) |
47+
| `warning_color` | Cautionary indicators (e.g. alerts that need attention) |
48+
| `danger_color` | Error or destructive state indicators |
49+
| `text_color` | Default text color |
50+
51+
### Background Color
52+
53+
The background color supports additional granularity. Beyond `base`, `weak`,
54+
`strong`, and `text`, you can also specify intermediate levels:
55+
56+
```toml
57+
[appearance.background_color]
58+
base = "#1e1e2e"
59+
weakest = "#1a1a28"
60+
weaker = "#1c1c2c"
61+
weak = "#313244"
62+
neutral = "#3a3a50"
63+
strong = "#45475a"
64+
stronger = "#505268"
65+
strongest = "#5a5c76"
66+
text = "#cdd6f4"
67+
```
68+
69+
All levels are optional. When omitted, they are auto-generated as
70+
gradual steps between the base color and the text color, providing
71+
a range of surface tones from subtle to prominent.
72+
73+
## Workspace Colors
74+
75+
You can specify which color to use for workspace indicators based on
76+
the monitor to which a workspace is attached.
77+
78+
For example, if workspace 1 is attached to `monitorA`, the first
79+
color will be used; if workspace 2 is attached to `monitorB`,
80+
the second color will be used, and so on.
81+
82+
Use the `workspace_colors` field for regular workspaces, and
83+
`special_workspace_colors` for special workspaces.
84+
85+
If `special_workspace_colors` is not defined, `workspace_colors` will be used.
86+
If neither `workspace_colors` is defined nor a color exists
87+
for a given monitor, the `primary_color` will be used.
88+
89+
## Complete Examples
90+
91+
For complete theme examples with full palette configurations, see the [Theme documentation](./theme.md).
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
sidebar_position: 3
3+
---
4+
5+
# Theme
6+
7+
## Catppuccin Mocha
8+
9+
```toml
10+
[appearance]
11+
12+
success_color = "#a6e3a1"
13+
warning_color = "#f9e2af"
14+
danger_color = "#f38ba8"
15+
text_color = "#cdd6f4"
16+
17+
workspace_colors = [ "#fab387", "#b4befe", "#cba6f7" ]
18+
19+
[appearance.primary_color]
20+
base = "#fab387"
21+
text = "#1e1e2e"
22+
23+
[appearance.background_color]
24+
base = "#1e1e2e"
25+
weak = "#313244"
26+
strong = "#45475a"
27+
```
28+
29+
## Tokyo Night - night
30+
31+
```toml
32+
[appearance]
33+
34+
primary_color = "#7aa2f7"
35+
success_color = "#9ece6a"
36+
warning_color = "#e0af68"
37+
danger_color = "#f7768e"
38+
text_color = "#a9b1d6"
39+
40+
workspace_colors = [ "#7aa2f7", "#9ece6a" ]
41+
42+
[appearance.background_color]
43+
base = "#1a1b26"
44+
weak = "#24273a"
45+
strong = "#414868"
46+
```
47+
48+
## Nord
49+
50+
```toml
51+
[appearance]
52+
success_color = "#a3be8c"
53+
warning_color = "#ebcb8b"
54+
danger_color = "#bf616a"
55+
text_color = "#eceff4"
56+
workspace_colors = [ "#88c0d0", "#81a1c1", "#5e81ac" ]
57+
58+
[appearance.primary_color]
59+
base = "#88c0d0"
60+
text = "#242933"
61+
62+
[appearance.background_color]
63+
base = "#3b4252"
64+
weak = "#434c5e"
65+
strong = "#4c566a"
66+
```

0 commit comments

Comments
 (0)