docs(mkdocs): offline install, stackbar, border style

This commit is contained in:
LGUG2Z
2024-04-05 18:25:36 -07:00
parent 251ec3d53e
commit e40fa11b0d
4 changed files with 37 additions and 2 deletions

View File

@@ -7,6 +7,7 @@ file.
```json ```json
{ {
"active_window_border": true, "active_window_border": true,
"active_window_border_style": "Rounded",
"active_window_border_colours": { "active_window_border_colours": {
"single": { "single": {
"r": 66, "r": 66,
@@ -23,7 +24,7 @@ file.
"g": 51, "g": 51,
"b": 153 "b": 153
} }
} },
} }
``` ```
@@ -31,7 +32,7 @@ file.
It is important to note that the active window border will only apply to It is important to note that the active window border will only apply to
windows managed by `komorebi`. windows managed by `komorebi`.
This feature is not considered stable and you may encounter visual artifacts This feature is not considered stable, and you may encounter visual artifacts
from time to time. from time to time.
[![Watch the tutorial [![Watch the tutorial

View File

@@ -0,0 +1,23 @@
# Stackbar
If you would like to add a visual stackbar to show which windows are in a container
stack ensure the following options are defined in the `komorebi.json` configuration
file.
```json
{
"stackbar": {
"height": 40,
"mode": "OnStack",
"tabs": {
"width": 300,
"focused_text": "#00a542",
"unfocused_text": "#b3b3b3",
"background": "#141414"
}
}
}
```
This feature is not considered stable, and you may encounter visual artifacts
from time to time.

View File

@@ -33,6 +33,7 @@ it from [source](https://github.com/LGUG2Z/komorebi) if you would prefer.
- [Scoop](#scoop) - [Scoop](#scoop)
- [WinGet](#winget) - [WinGet](#winget)
- [Building from source](#building-from-source) - [Building from source](#building-from-source)
- [Offline](#offline)
## Long path support ## Long path support
@@ -111,3 +112,12 @@ cargo +stable install --path komorebic-no-console --locked
If the binaries have been built and added to your `$PATH` correctly, you should If the binaries have been built and added to your `$PATH` correctly, you should
see some output when running `komorebi --help` and `komorebic --help` see some output when running `komorebi --help` and `komorebic --help`
### Offline
Download the latest [komorebi](https://github.com/LGUG2Z/komorebi/releases)
and [whkd](https://github.com/LGUG2Z/whkd/releases) MSI installers on an internet-connected computer, then copy them to
an offline machine to install.
Once installed, proceed to get the [example configurations](example-configurations.md) (none of the commands for
first-time set up and running komorebi require an internet connection).

View File

@@ -53,6 +53,7 @@ nav:
- Common workflows: - Common workflows:
- common-workflows/komorebi-config-home.md - common-workflows/komorebi-config-home.md
- common-workflows/active-window-border.md - common-workflows/active-window-border.md
- common-workflows/stackbar.md
- common-workflows/remove-gaps.md - common-workflows/remove-gaps.md
- common-workflows/ignore-windows.md - common-workflows/ignore-windows.md
- common-workflows/force-manage-windows.md - common-workflows/force-manage-windows.md