Skip to content

Commit

Permalink
docs(mkdocs): offline install, stackbar, border style
Browse files Browse the repository at this point in the history
  • Loading branch information
LGUG2Z committed Apr 6, 2024
1 parent 251ec3d commit e40fa11
Show file tree
Hide file tree
Showing 4 changed files with 37 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/common-workflows/active-window-border.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ file.
```json
{
"active_window_border": true,
"active_window_border_style": "Rounded",
"active_window_border_colours": {
"single": {
"r": 66,
Expand All @@ -23,15 +24,15 @@ file.
"g": 51,
"b": 153
}
}
},
}

```

It is important to note that the active window border will only apply to
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.

[![Watch the tutorial
Expand Down
23 changes: 23 additions & 0 deletions docs/common-workflows/stackbar.md
Original file line number Diff line number Diff line change
@@ -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.
10 changes: 10 additions & 0 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ it from [source](https://github.com/LGUG2Z/komorebi) if you would prefer.
- [Scoop](#scoop)
- [WinGet](#winget)
- [Building from source](#building-from-source)
- [Offline](#offline)

## Long path support

Expand Down Expand Up @@ -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
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).
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ nav:
- Common workflows:
- common-workflows/komorebi-config-home.md
- common-workflows/active-window-border.md
- common-workflows/stackbar.md
- common-workflows/remove-gaps.md
- common-workflows/ignore-windows.md
- common-workflows/force-manage-windows.md
Expand Down

0 comments on commit e40fa11

Please sign in to comment.