mirror of
https://github.com/LGUG2Z/komorebi.git
synced 2026-11-16 05:41:16 +01:00
style(mkdocs): add information about komorebi-bar
This commit is contained in:
1 parent
b02711e86d
commit
a8a2f923cf
2 files changed
+31
-2
No files matched your search
@@ -26,12 +26,18 @@ it requires to run, and will open the following System Settings tabs for you:
|
||||
* Settings -> Privacy & Security -> Screen & System Audio Recording
|
||||
|
||||
With the example configurations downloaded and permissions granted, you can now
|
||||
start `komorebi`
|
||||
start `komorebi`:
|
||||
|
||||
```powershell
|
||||
komorebic start
|
||||
```
|
||||
|
||||
Alternatively, if you also want to start with the status bar, you can run:
|
||||
|
||||
```powershell
|
||||
komorebic start --bar
|
||||
```
|
||||
|
||||
## komorebi.json
|
||||
|
||||
The example window manager configuration sets some sane defaults and provides
|
||||
@@ -173,4 +179,25 @@ colon.
|
||||
```
|
||||
|
||||
You can try the example komorebi configuration by running
|
||||
`skhd --config ~/.config/komorebi/skhdrc`.
|
||||
`skhd --config ~/.config/komorebi/skhdrc`.
|
||||
|
||||
## komorebi.bar.json
|
||||
|
||||
The example status bar configuration sets some sane defaults and provides
|
||||
a number of pre-configured widgets on the primary monitor.
|
||||
|
||||
```json
|
||||
{% include "./komorebi.bar.example.json" %}
|
||||
```
|
||||
|
||||
### Themes
|
||||
|
||||
Themes can be set in either `komorebi.json` or `komorebi.bar.json`. If set
|
||||
in `komorebi.json`, the theme will be applied to both komorebi's borders and
|
||||
stackbars as well as the status bar.
|
||||
|
||||
If set in `komorebi.bar.json`, the theme will only be applied to the status bar.
|
||||
|
||||
All [Catppuccin palette variants](https://catppuccin.com/)
|
||||
and [most Base16 palette variants](https://tinted-theming.github.io/tinted-gallery/)
|
||||
are available as themes.
|
||||
@@ -28,6 +28,7 @@ Clone the git repository, enter the directory, and build the following binaries:
|
||||
```powershell
|
||||
cargo +stable install --path komorebi --locked --target-dir ~/.cargo/bin
|
||||
cargo +stable install --path komorebic --locked --target-dir ~/.cargo/bin
|
||||
cargo +stable install --path komorebi-bar --locked --target-dir ~/.cargo/bin
|
||||
```
|
||||
|
||||
If the binaries have been built and added to your `$PATH` correctly, you should
|
||||
@@ -47,6 +48,7 @@ Finally, you can run the following commands to clean up files created by the
|
||||
```powershell
|
||||
rm -rf ~/.cargo/bin/komorebi
|
||||
rm -rf ~/.cargo/bin/komorebic
|
||||
rm -rf ~/.cargo/bin/komorebi-bar
|
||||
rm -rf ~/.config/komorebi
|
||||
rm -rf "~/Library/Application Support/komorebi"
|
||||
```
|
||||
Reference in new issue
Block a user