mirror of
https://github.com/LGUG2Z/komorebi.git
synced 2026-07-14 17:12:58 +02:00
docs(mkdocs): run docgen, depgen and jsonschema targets
This commit is contained in:
+263
-251
File diff suppressed because it is too large
Load Diff
@@ -7,7 +7,7 @@ Usage: komorebic.exe change-layout <DEFAULT_LAYOUT>
|
|||||||
|
|
||||||
Arguments:
|
Arguments:
|
||||||
<DEFAULT_LAYOUT>
|
<DEFAULT_LAYOUT>
|
||||||
[possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack]
|
[possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack, scrolling]
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
-h, --help
|
-h, --help
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ Arguments:
|
|||||||
The number of window containers on-screen required to trigger this layout rule
|
The number of window containers on-screen required to trigger this layout rule
|
||||||
|
|
||||||
<LAYOUT>
|
<LAYOUT>
|
||||||
[possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack]
|
[possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack, scrolling]
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
-h, --help
|
-h, --help
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ Arguments:
|
|||||||
Target workspace name
|
Target workspace name
|
||||||
|
|
||||||
<VALUE>
|
<VALUE>
|
||||||
[possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack]
|
[possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack, scrolling]
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
-h, --help
|
-h, --help
|
||||||
|
|||||||
@@ -0,0 +1,16 @@
|
|||||||
|
# scrolling-layout-columns
|
||||||
|
|
||||||
|
```
|
||||||
|
Set the number of visible columns for the Scrolling layout on the focused workspace
|
||||||
|
|
||||||
|
Usage: komorebic.exe scrolling-layout-columns <COUNT>
|
||||||
|
|
||||||
|
Arguments:
|
||||||
|
<COUNT>
|
||||||
|
Desired number of visible columns
|
||||||
|
|
||||||
|
Options:
|
||||||
|
-h, --help
|
||||||
|
Print help
|
||||||
|
|
||||||
|
```
|
||||||
@@ -16,7 +16,7 @@ Arguments:
|
|||||||
The number of window containers on-screen required to trigger this layout rule
|
The number of window containers on-screen required to trigger this layout rule
|
||||||
|
|
||||||
<LAYOUT>
|
<LAYOUT>
|
||||||
[possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack]
|
[possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack, scrolling]
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
-h, --help
|
-h, --help
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ Arguments:
|
|||||||
Workspace index on the specified monitor (zero-indexed)
|
Workspace index on the specified monitor (zero-indexed)
|
||||||
|
|
||||||
<VALUE>
|
<VALUE>
|
||||||
[possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack]
|
[possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack, scrolling]
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
-h, --help
|
-h, --help
|
||||||
|
|||||||
@@ -0,0 +1,31 @@
|
|||||||
|
# workspace-work-area-offset
|
||||||
|
|
||||||
|
```
|
||||||
|
Set offsets for a workspace to exclude parts of the work area from tiling
|
||||||
|
|
||||||
|
Usage: komorebic.exe workspace-work-area-offset <MONITOR> <WORKSPACE> <LEFT> <TOP> <RIGHT> <BOTTOM>
|
||||||
|
|
||||||
|
Arguments:
|
||||||
|
<MONITOR>
|
||||||
|
Monitor index (zero-indexed)
|
||||||
|
|
||||||
|
<WORKSPACE>
|
||||||
|
Workspace index (zero-indexed)
|
||||||
|
|
||||||
|
<LEFT>
|
||||||
|
Size of the left work area offset (set right to left * 2 to maintain right padding)
|
||||||
|
|
||||||
|
<TOP>
|
||||||
|
Size of the top work area offset (set bottom to the same value to maintain bottom padding)
|
||||||
|
|
||||||
|
<RIGHT>
|
||||||
|
Size of the right work area offset
|
||||||
|
|
||||||
|
<BOTTOM>
|
||||||
|
Size of the bottom work area offset
|
||||||
|
|
||||||
|
Options:
|
||||||
|
-h, --help
|
||||||
|
Print help
|
||||||
|
|
||||||
|
```
|
||||||
+3
-1
@@ -158,6 +158,7 @@ nav:
|
|||||||
- cli/invisible-borders.md
|
- cli/invisible-borders.md
|
||||||
- cli/global-work-area-offset.md
|
- cli/global-work-area-offset.md
|
||||||
- cli/monitor-work-area-offset.md
|
- cli/monitor-work-area-offset.md
|
||||||
|
- cli/workspace-work-area-offset.md
|
||||||
- cli/toggle-window-based-work-area-offset.md
|
- cli/toggle-window-based-work-area-offset.md
|
||||||
- cli/focused-workspace-container-padding.md
|
- cli/focused-workspace-container-padding.md
|
||||||
- cli/focused-workspace-padding.md
|
- cli/focused-workspace-padding.md
|
||||||
@@ -165,6 +166,7 @@ nav:
|
|||||||
- cli/adjust-workspace-padding.md
|
- cli/adjust-workspace-padding.md
|
||||||
- cli/change-layout.md
|
- cli/change-layout.md
|
||||||
- cli/cycle-layout.md
|
- cli/cycle-layout.md
|
||||||
|
- cli/scrolling-layout-columns.md
|
||||||
- cli/flip-layout.md
|
- cli/flip-layout.md
|
||||||
- cli/promote.md
|
- cli/promote.md
|
||||||
- cli/promote-focus.md
|
- cli/promote-focus.md
|
||||||
@@ -253,4 +255,4 @@ nav:
|
|||||||
- cli/static-config-schema.md
|
- cli/static-config-schema.md
|
||||||
- cli/generate-static-config.md
|
- cli/generate-static-config.md
|
||||||
- cli/enable-autostart.md
|
- cli/enable-autostart.md
|
||||||
- cli/disable-autostart.md
|
- cli/disable-autostart.md
|
||||||
|
|||||||
@@ -1111,6 +1111,14 @@
|
|||||||
]
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
},
|
||||||
|
"show_read_only_disks": {
|
||||||
|
"description": "Show disks that are read only. (default: false)",
|
||||||
|
"type": "boolean"
|
||||||
|
},
|
||||||
|
"show_removable_disks": {
|
||||||
|
"description": "Show removable disks. (default: true)",
|
||||||
|
"type": "boolean"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -2755,6 +2763,14 @@
|
|||||||
]
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
},
|
||||||
|
"show_read_only_disks": {
|
||||||
|
"description": "Show disks that are read only. (default: false)",
|
||||||
|
"type": "boolean"
|
||||||
|
},
|
||||||
|
"show_removable_disks": {
|
||||||
|
"description": "Show removable disks. (default: true)",
|
||||||
|
"type": "boolean"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -59617,6 +59633,14 @@
|
|||||||
]
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
},
|
||||||
|
"show_read_only_disks": {
|
||||||
|
"description": "Show disks that are read only. (default: false)",
|
||||||
|
"type": "boolean"
|
||||||
|
},
|
||||||
|
"show_removable_disks": {
|
||||||
|
"description": "Show removable disks. (default: true)",
|
||||||
|
"type": "boolean"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1846,6 +1846,10 @@
|
|||||||
"description": "Name",
|
"description": "Name",
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
|
"tile": {
|
||||||
|
"description": "Enable or disable tiling for the workspace (default: true)",
|
||||||
|
"type": "boolean"
|
||||||
|
},
|
||||||
"wallpaper": {
|
"wallpaper": {
|
||||||
"description": "Specify a wallpaper for this workspace",
|
"description": "Specify a wallpaper for this workspace",
|
||||||
"type": "object",
|
"type": "object",
|
||||||
|
|||||||
Reference in New Issue
Block a user