docs(mkdocs): add updates for v0.1.28 features

README.md

@@ -358,7 +358,7 @@ every `WindowManagerEvent` and `SocketMessage` handled by `komorebi` in a Rust c
 Below is a simple example of how to use `komorebi-client` in a basic Rust application.
 
 ```rust
-// komorebi-client = { git = "/~https://github.com/LGUG2Z/komorebi", tag = "v0.1.25"}
+// komorebi-client = { git = "/~https://github.com/LGUG2Z/komorebi", tag = "v0.1.28"}
 
 use anyhow::Result;
 use komorebi_client::Notification;

docs/cli/border-implementation.md

@@ -0,0 +1,20 @@
+# border-implementation
+
+```
+Set the border implementation
+
+Usage: komorebic.exe border-implementation <STYLE>
+
+Arguments:
+  <STYLE>
+          Desired border implementation
+
+          Possible values:
+          - komorebi: Use the adjustable komorebi border implementation
+          - windows:  Use the thin Windows accent border implementation
+
+Options:
+  -h, --help
+          Print help (see a summary with '-h')
+
+```

docs/cli/border-style.md

@@ -0,0 +1,21 @@
+# border-style
+
+```
+Set the border style
+
+Usage: komorebic.exe border-style <STYLE>
+
+Arguments:
+  <STYLE>
+          Desired border style
+
+          Possible values:
+          - system:  Use the system border style
+          - rounded: Use the Windows 11-style rounded borders
+          - square:  Use the Windows 10-style square borders
+
+Options:
+  -h, --help
+          Print help (see a summary with '-h')
+
+```

docs/cli/clear-all-workspace-rules.md

@@ -0,0 +1,12 @@
+# clear-all-workspace-rules
+
+```
+Remove all application association rules for all workspaces
+
+Usage: komorebic.exe clear-all-workspace-rules
+
+Options:
+  -h, --help
+          Print help
+
+```

docs/cli/clear-named-workspace-rules.md

@@ -0,0 +1,16 @@
+# clear-named-workspace-rules
+
+```
+Remove all application association rules for a named workspace
+
+Usage: komorebic.exe clear-named-workspace-rules <WORKSPACE>
+
+Arguments:
+  <WORKSPACE>
+          Name of a workspace
+
+Options:
+  -h, --help
+          Print help
+
+```

docs/cli/clear-workspace-rules.md

@@ -0,0 +1,19 @@
+# clear-workspace-rules
+
+```
+Remove all application association rules for a workspace by monitor and workspace index
+
+Usage: komorebic.exe clear-workspace-rules <MONITOR> <WORKSPACE>
+
+Arguments:
+  <MONITOR>
+          Monitor index (zero-indexed)
+
+  <WORKSPACE>
+          Workspace index on the specified monitor (zero-indexed)
+
+Options:
+  -h, --help
+          Print help
+
+```

docs/cli/window-hiding-behaviour.md

@@ -10,7 +10,7 @@ Arguments:
           Possible values:
           - hide:     Use the SW_HIDE flag to hide windows when switching workspaces (has issues with Electron apps)
           - minimize: Use the SW_MINIMIZE flag to hide windows when switching workspaces (has issues with frequent workspace switching)
-          - cloak:    Use the undocumented SetCloak Win32 function to hide windows when switching workspaces (has foregrounding issues)
+          - cloak:    Use the undocumented SetCloak Win32 function to hide windows when switching workspaces
 
 Options:
   -h, --help

docs/common-workflows/animations.md

@@ -0,0 +1,25 @@
+# Animations
+
+If you would like to add window movement animations, ensure the following options are
+defined in the `komorebi.json` configuration file.
+
+```json
+{
+  "animation": {
+    "enabled": true
+  }
+}
+```
+
+Window movement animations only apply to actions taking place within the same monitor
+workspace.
+
+You can optionally set a custom duration in ms with `animation.duration` (default: `250`),
+a custom style with `animation.style` (default: `Linear`), and a custom FPS value with
+`animation.fps` (default: `60`).
+
+It is important to note that higher `fps` and a longer `duration` settings will result
+in increased CPU usage.
+
+This feature is not considered stable, and you may encounter visual artifacts
+from time to time.

docs/komorebi.example.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://raw.githubusercontent.com/LGUG2Z/komorebi/v0.1.25/schema.json",
+  "$schema": "https://raw.githubusercontent.com/LGUG2Z/komorebi/v0.1.28/schema.json",
   "app_specific_configuration_path": "$Env:USERPROFILE/applications.yaml",
   "window_hiding_behaviour": "Cloak",
   "cross_monitor_move_behaviour": "Insert",

mkdocs.yml

@@ -57,6 +57,7 @@ nav:
       - Troubleshooting: troubleshooting.md
   - Common workflows:
       - common-workflows/komorebi-config-home.md
+      - common-workflows/animations.md
       - common-workflows/autohotkey.md
       - common-workflows/borders.md
       - common-workflows/stackbar.md
@@ -191,6 +192,9 @@ nav:
       - cli/initial-named-workspace-rule.md
       - cli/workspace-rule.md
       - cli/named-workspace-rule.md
+      - cli/clear-workspace-rules.md
+      - cli/clear-named-workspace-rules.md
+      - cli/clear-all-workspace-rules.md
       - cli/identify-object-name-change-application.md
       - cli/identify-tray-application.md
       - cli/identify-layered-application.md
@@ -200,6 +204,8 @@ nav:
       - cli/border-colour.md
       - cli/border-width.md
       - cli/border-offset.md
+      - cli/border-style.md
+      - cli/border-implementation.md
       - cli/transparency.md
       - cli/transparency-alpha.md
       - cli/focus-follows-mouse.md