mirror of
https://github.com/LGUG2Z/komorebi.git
synced 2026-11-17 14:21:22 +01:00
docs(starlight): regenerate the macOS references with just docgen
The pages the unified macOS binaries and schemas make, as of this commit: the commands the site did not have yet (consume, expel, pan and others) and the changed help of the rules. The Windows pages are not regenerated: komorebic for Windows does not run on this host. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This commit is contained in:
1 parent
47cde0d279
commit
f19788100b
25 files changed
+387
-31
No files matched your search
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "komorebi.bar.json (macOS)"
|
||||
description: "komorebi-bar for Mac configuration schema reference"
|
||||
title: "komorebi.bar.json (macos)"
|
||||
description: "komorebi-bar configuration schema reference for macos"
|
||||
---
|
||||
|
||||
import { Badge } from '@astrojs/starlight/components';
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "komorebi.json (macOS)"
|
||||
description: "komorebi for Mac configuration schema reference"
|
||||
title: "komorebi.json (macos)"
|
||||
description: "komorebi configuration schema reference for macos"
|
||||
---
|
||||
|
||||
import { Badge } from '@astrojs/starlight/components';
|
||||
@@ -285,6 +285,18 @@ Monitor and workspace configurations
|
||||
|
||||
|
||||
|
||||
---
|
||||
### monocle_focus_behaviour {#monocle_focus_behaviour}
|
||||
|
||||
<Badge text="optional" variant="note" /> [`MonocleFocusBehaviour`](#monoclefocusbehaviour)
|
||||
|
||||
Determine what happens when focusing in a direction while a monocle container is active
|
||||
|
||||
|
||||
|
||||
**Default:** [`"NoOp"`](#monoclefocusbehaviour)
|
||||
|
||||
|
||||
---
|
||||
### mouse_follows_focus {#mouse_follows_focus}
|
||||
|
||||
@@ -864,7 +876,7 @@ Ease in out bounce
|
||||
#### CubicBezier
|
||||
|
||||
|
||||
Custom Cubic Bézier function
|
||||
Custom Cubic Bezier function
|
||||
|
||||
|
||||
|
||||
@@ -880,6 +892,7 @@ Custom Cubic Bézier function
|
||||
|
||||
**Configuration:**
|
||||
- [`.animation.style`](#peranimationprefixconfig3)
|
||||
- [`.animation.style[*]`](#peranimationprefixconfig3)
|
||||
|
||||
|
||||
**Referenced by:**
|
||||
@@ -1040,7 +1053,7 @@ Executable name
|
||||
#### Class
|
||||
|
||||
|
||||
Role or subrole
|
||||
Accessibility subrole or role, such as AXStandardWindow
|
||||
|
||||
|
||||
|
||||
@@ -1120,7 +1133,7 @@ Aspect ratio for temporarily floating windows
|
||||
#### Predefined
|
||||
|
||||
|
||||
A predefined aspect ratio
|
||||
Predefined aspect ratio
|
||||
|
||||
|
||||
|
||||
@@ -1136,7 +1149,7 @@ A predefined aspect ratio
|
||||
#### Custom
|
||||
|
||||
|
||||
A custom W:H aspect ratio
|
||||
Custom W:H aspect ratio
|
||||
|
||||
|
||||
|
||||
@@ -7758,6 +7771,59 @@ Workspace padding (default: global)
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
### MonocleFocusBehaviour {#monoclefocusbehaviour}
|
||||
|
||||
Behaviour when focusing in a direction while a monocle container is active
|
||||
|
||||
|
||||
|
||||
|
||||
<details open>
|
||||
<summary>Enum variants (2)</summary>
|
||||
|
||||
|
||||
---
|
||||
|
||||
#### Cycle
|
||||
|
||||
|
||||
Cycle the monocle container to the next/previous container in the workspace
|
||||
|
||||
|
||||
|
||||
|
||||
**Value:** `"Cycle"`
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
#### NoOp
|
||||
|
||||
|
||||
Do nothing, allowing focus to fall through to cross-monitor logic
|
||||
|
||||
|
||||
|
||||
|
||||
**Value:** `"NoOp"`
|
||||
|
||||
|
||||
|
||||
|
||||
</details>
|
||||
#### Usages
|
||||
|
||||
**Configuration:**
|
||||
- [`.monocle_focus_behaviour`](#monocle_focus_behaviour)
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -8322,6 +8388,84 @@ Red
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
### ScrollingCentering {#scrollingcentering}
|
||||
|
||||
When the Scrolling layout centres the focused column
|
||||
|
||||
A boolean is also accepted when reading, for the layout option that used to be one: `true` is
|
||||
`Always` and `false` is `Never`.
|
||||
|
||||
|
||||
|
||||
|
||||
<details open>
|
||||
<summary>Enum variants (3)</summary>
|
||||
|
||||
|
||||
---
|
||||
|
||||
#### Never
|
||||
|
||||
|
||||
Scroll just far enough to bring the focused column into view, and no further
|
||||
|
||||
|
||||
|
||||
|
||||
**Value:** `"Never"`
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
#### Always
|
||||
|
||||
|
||||
Keep the focused column in the middle of the screen
|
||||
|
||||
|
||||
|
||||
|
||||
**Value:** `"Always"`
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
#### OnOverflow
|
||||
|
||||
|
||||
Centre the focused column when it does not fit on the screen together with the column that
|
||||
focus came from
|
||||
|
||||
|
||||
|
||||
|
||||
**Value:** `"OnOverflow"`
|
||||
|
||||
|
||||
|
||||
|
||||
</details>
|
||||
#### Usages
|
||||
|
||||
**Configuration:**
|
||||
- [`.layout_defaults[*].layout_options.scrolling.center_focused_column`](#scrollinglayoutoptions-center_focused_column)
|
||||
- [`.layout_defaults[*].layout_options_rules[*].scrolling.center_focused_column`](#scrollinglayoutoptions-center_focused_column)
|
||||
- [`.monitors[].workspaces[].layout_options.scrolling.center_focused_column`](#scrollinglayoutoptions-center_focused_column)
|
||||
- [`.monitors[].workspaces[].layout_options_rules[*].scrolling.center_focused_column`](#scrollinglayoutoptions-center_focused_column)
|
||||
|
||||
|
||||
**Referenced by:**
|
||||
- [`ScrollingLayoutOptions`](#scrollinglayoutoptions)
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -8348,12 +8492,62 @@ Desired number of visible columns (default: 3)
|
||||
|
||||
#### center_focused_column {#scrollinglayoutoptions-center_focused_column}
|
||||
|
||||
<Badge text="optional" variant="note" /> `boolean`
|
||||
`enum`
|
||||
|
||||
With an odd number of visible columns, keep the focused window column centered
|
||||
When to centre the focused column: `Never` (the default), `Always`, or `OnOverflow`, which
|
||||
is when it does not fit on the screen together with the column that focus came from. A
|
||||
boolean is also accepted, where `true` is `Always` and `false` is `Never`
|
||||
|
||||
|
||||
|
||||
<details open>
|
||||
<summary>Enum variants (3)</summary>
|
||||
|
||||
|
||||
---
|
||||
|
||||
#### Boolean
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
**Value:** `boolean`
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
#### ScrollingCentering
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
**Value:** [`ScrollingCentering`](#scrollingcentering)
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
#### Null
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
**Value:** `null`
|
||||
|
||||
|
||||
|
||||
|
||||
</details>
|
||||
|
||||
</details>
|
||||
#### Usages
|
||||
|
||||
|
||||
@@ -10,10 +10,13 @@ Arguments:
|
||||
Options:
|
||||
-a, --animation-type <ANIMATION_TYPE>
|
||||
Animation type to apply the duration to. If not specified, sets global duration
|
||||
|
||||
[possible values: movement]
|
||||
|
||||
Possible values:
|
||||
- movement
|
||||
- transparency
|
||||
- workspace: A workspace sliding in and out of a monitor when it is switched to
|
||||
|
||||
-h, --help
|
||||
Print help
|
||||
Print help (see a summary with '-h')
|
||||
|
||||
```
|
||||
@@ -44,8 +44,11 @@ Options:
|
||||
|
||||
-a, --animation-type <ANIMATION_TYPE>
|
||||
Animation type to apply the style to. If not specified, sets global style
|
||||
|
||||
[possible values: movement]
|
||||
|
||||
Possible values:
|
||||
- movement
|
||||
- transparency
|
||||
- workspace: A workspace sliding in and out of a monitor when it is switched to
|
||||
|
||||
-h, --help
|
||||
Print help (see a summary with '-h')
|
||||
|
||||
@@ -10,10 +10,13 @@ Arguments:
|
||||
Options:
|
||||
-a, --animation-type <ANIMATION_TYPE>
|
||||
Animation type to apply the state to. If not specified, sets global state
|
||||
|
||||
[possible values: movement]
|
||||
|
||||
Possible values:
|
||||
- movement
|
||||
- transparency
|
||||
- workspace: A workspace sliding in and out of a monitor when it is switched to
|
||||
|
||||
-h, --help
|
||||
Print help
|
||||
Print help (see a summary with '-h')
|
||||
|
||||
```
|
||||
@@ -15,10 +15,17 @@ Arguments:
|
||||
|
||||
Options:
|
||||
-w, --window-kind <WINDOW_KIND>
|
||||
Possible values:
|
||||
- single: Single window
|
||||
- stack: Stack container
|
||||
- monocle: Monocle container
|
||||
- unfocused: Unfocused window
|
||||
- unfocused-locked: Unfocused locked container
|
||||
- floating: Floating window
|
||||
|
||||
[default: single]
|
||||
[possible values: single, stack, monocle, unfocused, unfocused-locked, floating]
|
||||
|
||||
-h, --help
|
||||
Print help
|
||||
Print help (see a summary with '-h')
|
||||
|
||||
```
|
||||
@@ -0,0 +1,10 @@
|
||||
```
|
||||
Scroll the Scrolling layout so that the focused column is in the middle of the screen, once
|
||||
|
||||
Usage: center-focus
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
Print help
|
||||
|
||||
```
|
||||
@@ -0,0 +1,14 @@
|
||||
```
|
||||
Take the neighbouring window on one side into the focused column of the Scrolling layout
|
||||
|
||||
Usage: consume <OPERATION_DIRECTION>
|
||||
|
||||
Arguments:
|
||||
<OPERATION_DIRECTION>
|
||||
[possible values: left, right, up, down]
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
Print help
|
||||
|
||||
```
|
||||
@@ -6,9 +6,11 @@ Usage: cross-monitor-move-behaviour <MOVE_BEHAVIOUR>
|
||||
Arguments:
|
||||
<MOVE_BEHAVIOUR>
|
||||
Possible values:
|
||||
- swap: Swap the window container with the window container at the edge of the adjacent monitor
|
||||
- swap: Swap the window container with the window container at the edge of the adjacent
|
||||
monitor
|
||||
- insert: Insert the window container into the focused workspace on the adjacent monitor
|
||||
- no-op: Do nothing if trying to move a window container in the direction of an adjacent monitor
|
||||
- no-op: Do nothing if trying to move a window container in the direction of an adjacent
|
||||
monitor
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
```
|
||||
Make the focused column of the Scrolling layout fill the room that the columns in view leave on the
|
||||
screen, which does nothing in any other layout
|
||||
|
||||
Usage: expand
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
Print help
|
||||
|
||||
```
|
||||
@@ -0,0 +1,11 @@
|
||||
```
|
||||
Take the focused window out of its column in the Scrolling layout and put it in a column of its own
|
||||
on the right
|
||||
|
||||
Usage: expel
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
Print help
|
||||
|
||||
```
|
||||
@@ -7,7 +7,7 @@ Arguments:
|
||||
<IDENTIFIER>
|
||||
Possible values:
|
||||
- exe: Executable name
|
||||
- class: Role or subrole
|
||||
- class: Accessibility subrole or role, such as AXStandardWindow
|
||||
- title: Window title
|
||||
- path: Executable path
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ Arguments:
|
||||
<IDENTIFIER>
|
||||
Possible values:
|
||||
- exe: Executable name
|
||||
- class: Role or subrole
|
||||
- class: Accessibility subrole or role, such as AXStandardWindow
|
||||
- title: Window title
|
||||
- path: Executable path
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ Arguments:
|
||||
<IDENTIFIER>
|
||||
Possible values:
|
||||
- exe: Executable name
|
||||
- class: Role or subrole
|
||||
- class: Accessibility subrole or role, such as AXStandardWindow
|
||||
- title: Window title
|
||||
- path: Executable path
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ Arguments:
|
||||
<IDENTIFIER>
|
||||
Possible values:
|
||||
- exe: Executable name
|
||||
- class: Role or subrole
|
||||
- class: Accessibility subrole or role, such as AXStandardWindow
|
||||
- title: Window title
|
||||
- path: Executable path
|
||||
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
```
|
||||
Set the behaviour when focusing in a direction while a monocle container is active
|
||||
|
||||
Usage: monocle-focus-behaviour <BEHAVIOUR>
|
||||
|
||||
Arguments:
|
||||
<BEHAVIOUR>
|
||||
Desired monocle focus behaviour
|
||||
|
||||
Possible values:
|
||||
- cycle: Cycle the monocle container to the next/previous container in the workspace
|
||||
- no-op: Do nothing, allowing focus to fall through to cross-monitor logic
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
Print help (see a summary with '-h')
|
||||
|
||||
```
|
||||
@@ -7,7 +7,7 @@ Arguments:
|
||||
<IDENTIFIER>
|
||||
Possible values:
|
||||
- exe: Executable name
|
||||
- class: Role or subrole
|
||||
- class: Accessibility subrole or role, such as AXStandardWindow
|
||||
- title: Window title
|
||||
- path: Executable path
|
||||
|
||||
|
||||
@@ -0,0 +1,43 @@
|
||||
```
|
||||
Move the view of the Scrolling layout a column to the left or the right, or with the fingers on a
|
||||
touchpad
|
||||
|
||||
The strip of columns moves by the width of a new column and comes to rest with a column against an
|
||||
edge of the screen. Focus stays on the column that has it if that is still fully in view, and
|
||||
otherwise goes to the nearest column that is. Only the Scrolling layout has a strip to move, so this
|
||||
does nothing in the other layouts.
|
||||
|
||||
With --stream the strip follows the fingers as they go, 10 centimetres of travel being the width of
|
||||
the screen, until they lift, and then comes to rest in the column that the speed that they lifted at
|
||||
takes it to. Standard input is the gesture stream that whkd writes on Windows, one message to a
|
||||
line: `begin`, `move dx=<cm> t=<ms>`, `end` and `cancel`. A gesture that is not finished when
|
||||
standard input closes is given up, and the strip goes back to where it was.
|
||||
|
||||
Usage: pan [OPTIONS] [DIRECTION]
|
||||
|
||||
Arguments:
|
||||
[DIRECTION]
|
||||
The way that the view goes
|
||||
|
||||
[possible values: left, right]
|
||||
|
||||
Options:
|
||||
--stream
|
||||
Read the gestures of fingers on a touchpad from standard input, in the gesture stream that
|
||||
whkd writes for a swipe of three or four fingers, and pan with them
|
||||
|
||||
--sensitivity <SENSITIVITY>
|
||||
What the distances of a gesture are multiplied by, which is 1 if it is left out, with
|
||||
--stream
|
||||
|
||||
--reversed
|
||||
Go the other way to the fingers, with --stream
|
||||
|
||||
--paging
|
||||
Take a step for every two centimetres that the fingers go, and not move the view with
|
||||
them, with --stream
|
||||
|
||||
-h, --help
|
||||
Print help (see a summary with '-h')
|
||||
|
||||
```
|
||||
@@ -5,7 +5,9 @@ Usage: query <STATE_QUERY>
|
||||
|
||||
Arguments:
|
||||
<STATE_QUERY>
|
||||
[possible values: focused-monitor-index, focused-workspace-index, focused-container-index, focused-window-index, focused-workspace-name, focused-workspace-layout, focused-container-kind, version]
|
||||
[possible values: focused-monitor-index, focused-workspace-index, focused-container-index,
|
||||
focused-window-index, focused-workspace-name, focused-workspace-layout,
|
||||
focused-container-kind, version]
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
```
|
||||
Make the focused column of the Scrolling layout as wide as the screen, or put it back to the width
|
||||
that it had
|
||||
|
||||
Usage: scrolling-layout-full-width
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
Print help
|
||||
|
||||
```
|
||||
@@ -0,0 +1,11 @@
|
||||
```
|
||||
Stack the windows of the focused column of the Scrolling layout, or spread the focused stack out
|
||||
into a column with a window in each slot
|
||||
|
||||
Usage: toggle-column-stack
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
Print help
|
||||
|
||||
```
|
||||
@@ -0,0 +1,10 @@
|
||||
```
|
||||
Toggle the behaviour when focusing in a direction while a monocle container is active
|
||||
|
||||
Usage: toggle-monocle-focus-behaviour
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
Print help
|
||||
|
||||
```
|
||||
@@ -1,5 +1,7 @@
|
||||
```
|
||||
Enable or disable float override, which makes it so every new window opens in floating mode, for the currently focused workspace. If there was no override value set for the workspace previously it takes the opposite of the global value
|
||||
Enable or disable float override, which makes it so every new window opens in floating mode, for the
|
||||
currently focused workspace. If there was no override value set for the workspace previously it
|
||||
takes the opposite of the global value
|
||||
|
||||
Usage: toggle-workspace-float-override
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
```
|
||||
Toggle the behaviour for new windows (stacking or dynamic tiling) for currently focused workspace. If there was no behaviour set for the workspace previously it takes the opposite of the global value
|
||||
Toggle the behaviour for new windows (stacking or dynamic tiling) for currently focused workspace.
|
||||
If there was no behaviour set for the workspace previously it takes the opposite of the global value
|
||||
|
||||
Usage: toggle-workspace-window-container-behaviour
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ Arguments:
|
||||
<IDENTIFIER>
|
||||
Possible values:
|
||||
- exe: Executable name
|
||||
- class: Role or subrole
|
||||
- class: Accessibility subrole or role, such as AXStandardWindow
|
||||
- title: Window title
|
||||
- path: Executable path
|
||||
|
||||
|
||||
Reference in new issue
Block a user