From e40fa11b0d18387d32d2ef44ef5b8dcbeb5b8d4e Mon Sep 17 00:00:00 2001 From: LGUG2Z Date: Fri, 5 Apr 2024 18:25:36 -0700 Subject: [PATCH] docs(mkdocs): offline install, stackbar, border style --- docs/common-workflows/active-window-border.md | 5 ++-- docs/common-workflows/stackbar.md | 23 +++++++++++++++++++ docs/installation.md | 10 ++++++++ mkdocs.yml | 1 + 4 files changed, 37 insertions(+), 2 deletions(-) create mode 100644 docs/common-workflows/stackbar.md diff --git a/docs/common-workflows/active-window-border.md b/docs/common-workflows/active-window-border.md index 46dce365..d02cf854 100644 --- a/docs/common-workflows/active-window-border.md +++ b/docs/common-workflows/active-window-border.md @@ -7,6 +7,7 @@ file. ```json { "active_window_border": true, + "active_window_border_style": "Rounded", "active_window_border_colours": { "single": { "r": 66, @@ -23,7 +24,7 @@ file. "g": 51, "b": 153 } - } + }, } ``` @@ -31,7 +32,7 @@ file. 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 diff --git a/docs/common-workflows/stackbar.md b/docs/common-workflows/stackbar.md new file mode 100644 index 00000000..3b1730b4 --- /dev/null +++ b/docs/common-workflows/stackbar.md @@ -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. \ No newline at end of file diff --git a/docs/installation.md b/docs/installation.md index 3d40ae9b..d0a728a0 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -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 @@ -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). diff --git a/mkdocs.yml b/mkdocs.yml index 11c433a6..4512a629 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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