From 381e7a4cff8da193d117a8444f048b913675a2d0 Mon Sep 17 00:00:00 2001 From: LGUG2Z Date: Sat, 7 Feb 2026 15:16:16 -0800 Subject: [PATCH] feat(docs): regenerate macos references --- src/content/docs/reference/bar-macos.mdx | 41 +++++---- src/content/docs/reference/komorebi-macos.mdx | 86 +++++++++++++++---- .../cli/macos/adjust-container-padding.md | 6 +- .../cli/macos/adjust-workspace-padding.md | 6 +- src/data/cli/macos/enable-autostart.md | 3 + src/data/cli/macos/permissions.md | 10 +++ src/data/cli/macos/resize-axis.md | 4 +- src/data/cli/macos/resize-edge.md | 6 +- 8 files changed, 118 insertions(+), 44 deletions(-) create mode 100644 src/data/cli/macos/permissions.md diff --git a/src/content/docs/reference/bar-macos.mdx b/src/content/docs/reference/bar-macos.mdx index 3c049003..e56ef352 100644 --- a/src/content/docs/reference/bar-macos.mdx +++ b/src/content/docs/reference/bar-macos.mdx @@ -12,20 +12,10 @@ import { Badge } from '@astrojs/starlight/components'; `array` [`WidgetConfig`](#widgetconfig) -Options for mouse interaction on the bar Left side widgets (ordered left-to-right) ---- -### monitor {#monitor} - - [`MonitorConfigOrIndex`](#monitorconfigorindex) - -The monitor index or the full monitor options - - - --- ### right_widgets {#right_widgets} @@ -114,7 +104,7 @@ Scale of the icons relative to the font_size [[1.0-2.0]] - **Format:** `float` -**Default:** `1.399999976158142` +**Default:** `1.4` --- @@ -163,6 +153,15 @@ Max label width before text truncation **Default:** `400.0` +--- +### monitor {#monitor} + + [`MonitorConfigOrIndex`](#monitorconfigorindex) + +The monitor index or the full monitor options + + + --- ### padding {#padding} @@ -5874,7 +5873,7 @@ A predefined komorebi layout BSP Layout -``` +```text +-------+-----+ | | | | +--+--+ @@ -5897,7 +5896,7 @@ BSP Layout Columns Layout -``` +```text +--+--+--+--+ | | | | | | | | | | @@ -5920,7 +5919,7 @@ Columns Layout Rows Layout -``` +```text +-----------+ |-----------| |-----------| @@ -5943,7 +5942,7 @@ Rows Layout Vertical Stack Layout -``` +```text +-------+-----+ | | | | +-----+ @@ -5966,7 +5965,7 @@ Vertical Stack Layout Horizontal Stack Layout -``` +```text +------+------+ | | |------+------+ @@ -5989,7 +5988,7 @@ Horizontal Stack Layout Ultrawide Vertical Stack Layout -``` +```text +-----+-----------+-----+ | | | | | | +-----+ @@ -6014,7 +6013,7 @@ Ultrawide Vertical Stack Layout Grid Layout -``` +```text +-----+-----+ +---+---+---+ +---+---+---+ +---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | +---+ @@ -6022,7 +6021,7 @@ Grid Layout | | | | | | | | | | | | | +---+ | | | | | | | | | | | | | | | +-----+-----+ +---+---+---+ +---+---+---+ +---+---+---+ - 4 windows 5 windows 6 windows 7 windows + 4 windows 5 windows 6 windows 7 windows ``` @@ -6040,7 +6039,7 @@ Grid Layout Right Main Vertical Stack Layout -``` +```text +-----+-------+ | | | +-----+ | @@ -6063,7 +6062,7 @@ Right Main Vertical Stack Layout Scrolling Layout -``` +```text +--+--+--+--+--+--+ | | | | | | | | diff --git a/src/content/docs/reference/komorebi-macos.mdx b/src/content/docs/reference/komorebi-macos.mdx index 6785e748..13bbb49b 100644 --- a/src/content/docs/reference/komorebi-macos.mdx +++ b/src/content/docs/reference/komorebi-macos.mdx @@ -59,9 +59,6 @@ Offset of window borders - **Format:** `int32` -**Default:** `5` - - --- ### border_radius {#border_radius} @@ -89,7 +86,7 @@ Width of window borders - **Format:** `int32` -**Default:** `6` +**Default:** `10` --- @@ -1146,7 +1143,7 @@ A custom W:H aspect ratio ### Axis {#axis} -An axis on which to perform an operation +Axis on which to perform an operation @@ -6435,7 +6432,7 @@ A predefined komorebi layout BSP Layout -``` +```text +-------+-----+ | | | | +--+--+ @@ -6458,7 +6455,7 @@ BSP Layout Columns Layout -``` +```text +--+--+--+--+ | | | | | | | | | | @@ -6481,7 +6478,7 @@ Columns Layout Rows Layout -``` +```text +-----------+ |-----------| |-----------| @@ -6504,7 +6501,7 @@ Rows Layout Vertical Stack Layout -``` +```text +-------+-----+ | | | | +-----+ @@ -6527,7 +6524,7 @@ Vertical Stack Layout Horizontal Stack Layout -``` +```text +------+------+ | | |------+------+ @@ -6550,7 +6547,7 @@ Horizontal Stack Layout Ultrawide Vertical Stack Layout -``` +```text +-----+-----------+-----+ | | | | | | +-----+ @@ -6575,7 +6572,7 @@ Ultrawide Vertical Stack Layout Grid Layout -``` +```text +-----+-----+ +---+---+---+ +---+---+---+ +---+---+---+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | +---+ @@ -6583,7 +6580,7 @@ Grid Layout | | | | | | | | | | | | | +---+ | | | | | | | | | | | | | | | +-----+-----+ +---+---+---+ +---+---+---+ +---+---+---+ - 4 windows 5 windows 6 windows 7 windows + 4 windows 5 windows 6 windows 7 windows ``` @@ -6601,7 +6598,7 @@ Grid Layout Right Main Vertical Stack Layout -``` +```text +-----+-------+ | | | +-----+ | @@ -6624,7 +6621,7 @@ Right Main Vertical Stack Layout Scrolling Layout -``` +```text +--+--+--+--+--+--+ | | | | | | | | @@ -7253,10 +7250,40 @@ Options for specific layouts
-Properties (2) +Properties (4) +#### column_ratios {#layoutoptions-column_ratios} + + `array` `number` + +Column width ratios (up to MAX_RATIOS values between 0.1 and 0.9) + +- Used by Columns layout: ratios for each column width +- Used by Grid layout: ratios for column widths +- Used by BSP, VerticalStack, RightMainVerticalStack: column_ratios[0] as primary split ratio +- Used by HorizontalStack: column_ratios[0] as primary split ratio (top area height) +- Used by UltrawideVerticalStack: column_ratios[0] as center ratio, column_ratios[1] as left ratio + +Columns without a ratio share remaining space equally. +Example: `[0.3, 0.4, 0.3]` for 30%-40%-30% columns + + + +- **Min items:** 5 +- **Max items:** 5 +
+Array Items + + `number` + + + + +- **Format:** `float` + +
#### grid {#layoutoptions-grid} [`GridLayoutOptions`](#gridlayoutoptions) @@ -7264,6 +7291,33 @@ Options for specific layouts Options related to the Grid layout +#### row_ratios {#layoutoptions-row_ratios} + + `array` `number` + +Row height ratios (up to MAX_RATIOS values between 0.1 and 0.9) + +- Used by Rows layout: ratios for each row height +- Used by Grid layout: ratios for row heights + +Rows without a ratio share remaining space equally. +Example: `[0.5, 0.5]` for 50%-50% rows + + + +- **Min items:** 5 +- **Max items:** 5 +
+Array Items + + `number` + + + + +- **Format:** `float` + +
#### scrolling {#layoutoptions-scrolling} [`ScrollingLayoutOptions`](#scrollinglayoutoptions) diff --git a/src/data/cli/macos/adjust-container-padding.md b/src/data/cli/macos/adjust-container-padding.md index 68c9e88b..a08fbbbd 100644 --- a/src/data/cli/macos/adjust-container-padding.md +++ b/src/data/cli/macos/adjust-container-padding.md @@ -5,13 +5,15 @@ Usage: adjust-container-padding Arguments: - [possible values: increase, decrease] + Possible values: + - increase: Increase + - decrease: Decrease Pixels to adjust by as an integer Options: -h, --help - Print help + Print help (see a summary with '-h') ``` \ No newline at end of file diff --git a/src/data/cli/macos/adjust-workspace-padding.md b/src/data/cli/macos/adjust-workspace-padding.md index 429fa233..239d6571 100644 --- a/src/data/cli/macos/adjust-workspace-padding.md +++ b/src/data/cli/macos/adjust-workspace-padding.md @@ -5,13 +5,15 @@ Usage: adjust-workspace-padding Arguments: - [possible values: increase, decrease] + Possible values: + - increase: Increase + - decrease: Decrease Pixels to adjust by as an integer Options: -h, --help - Print help + Print help (see a summary with '-h') ``` \ No newline at end of file diff --git a/src/data/cli/macos/enable-autostart.md b/src/data/cli/macos/enable-autostart.md index 18bca704..439bc458 100644 --- a/src/data/cli/macos/enable-autostart.md +++ b/src/data/cli/macos/enable-autostart.md @@ -7,6 +7,9 @@ Options: -c, --config Path to a static configuration JSON file + --bar + Enable autostart of komorebi-bar + -h, --help Print help diff --git a/src/data/cli/macos/permissions.md b/src/data/cli/macos/permissions.md new file mode 100644 index 00000000..9498e042 --- /dev/null +++ b/src/data/cli/macos/permissions.md @@ -0,0 +1,10 @@ +``` +Show the System Settings permissions dialogs required by komorebi + +Usage: permissions + +Options: + -h, --help + Print help + +``` \ No newline at end of file diff --git a/src/data/cli/macos/resize-axis.md b/src/data/cli/macos/resize-axis.md index 81494250..a87ac615 100644 --- a/src/data/cli/macos/resize-axis.md +++ b/src/data/cli/macos/resize-axis.md @@ -11,7 +11,9 @@ Arguments: - horizontal-and-vertical: Both horizontal and vertical axes - [possible values: increase, decrease] + Possible values: + - increase: Increase + - decrease: Decrease Options: -h, --help diff --git a/src/data/cli/macos/resize-edge.md b/src/data/cli/macos/resize-edge.md index 1e129ff3..6acf1a2f 100644 --- a/src/data/cli/macos/resize-edge.md +++ b/src/data/cli/macos/resize-edge.md @@ -8,10 +8,12 @@ Arguments: [possible values: left, right, up, down] - [possible values: increase, decrease] + Possible values: + - increase: Increase + - decrease: Decrease Options: -h, --help - Print help + Print help (see a summary with '-h') ``` \ No newline at end of file