starred/komorebi
1
0
Fork 0
mirror of https://github.com/LGUG2Z/komorebi.git synced 2026-05-11 05:09:45 +02:00
Code Issues 87 Packages Projects Releases 11 Wiki Activity

Deployed 9a3dbcc with MkDocs version: 1.5.3

Browse Source
This commit is contained in:
LGUG2Z
2024-11-03 16:23:25 -08:00
parent c37bc42074
commit b367e4aec2
182 changed files with 25356 additions and 73265 deletions
Download Patch File Download Diff File Expand all files Collapse all files

439
example-configurations.html
View File

@@ -283,26 +283,6 @@
<li class="md-tabs__item">
<a href="release/v0-1-22.html" class="md-tabs__link">
Release notes
</a>
</li>
<li class="md-tabs__item">
<a href="https://komorebi.lgug2z.com/schema" class="md-tabs__link">
@@ -763,6 +743,15 @@
<nav class="md-nav" aria-label="whkdrc">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#configuration" class="md-nav__link">
<span class="md-ellipsis">
Configuration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#setting-shell" class="md-nav__link">
<span class="md-ellipsis">
@@ -881,6 +870,8 @@
@@ -944,6 +935,27 @@
<li class="md-nav__item">
<a href="common-workflows/autostart.html" class="md-nav__link">
<span class="md-ellipsis">
Autostart
</span>
</a>
</li>
<li class="md-nav__item">
<a href="common-workflows/animations.html" class="md-nav__link">
@@ -1091,6 +1103,27 @@
<li class="md-nav__item">
<a href="common-workflows/floating-applications.html" class="md-nav__link">
<span class="md-ellipsis">
Floating Windows
</span>
</a>
</li>
<li class="md-nav__item">
<a href="common-workflows/tray-and-multi-window-applications.html" class="md-nav__link">
@@ -1112,27 +1145,6 @@
<li class="md-nav__item">
<a href="common-workflows/focus-follows-mouse.html" class="md-nav__link">
<span class="md-ellipsis">
Focus Follows Mouse
</span>
</a>
</li>
<li class="md-nav__item">
<a href="common-workflows/mouse-follows-focus.html" class="md-nav__link">
@@ -1154,27 +1166,6 @@
<li class="md-nav__item">
<a href="common-workflows/custom-layouts.html" class="md-nav__link">
<span class="md-ellipsis">
Custom Layouts
</span>
</a>
</li>
<li class="md-nav__item">
<a href="common-workflows/dynamic-layout-switching.html" class="md-nav__link">
@@ -1211,57 +1202,6 @@
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis">
Release notes
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Release notes
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -1269,11 +1209,11 @@
<li class="md-nav__item">
<a href="release/v0-1-22.html" class="md-nav__link">
<a href="common-workflows/multiple-bar-instances.html" class="md-nav__link">
<span class="md-ellipsis">
v0.1.22
Multiple Bar Instances
</span>
@@ -1636,14 +1576,6 @@
@@ -1665,10 +1597,10 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<span class="md-ellipsis">
@@ -1679,8 +1611,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
CLI reference
</label>
@@ -3183,27 +3115,6 @@
<li class="md-nav__item">
<a href="cli/load-custom-layout.html" class="md-nav__link">
<span class="md-ellipsis">
load-custom-layout
</span>
</a>
</li>
<li class="md-nav__item">
<a href="cli/flip-layout.html" class="md-nav__link">
@@ -3519,48 +3430,6 @@
<li class="md-nav__item">
<a href="cli/workspace-custom-layout.html" class="md-nav__link">
<span class="md-ellipsis">
workspace-custom-layout
</span>
</a>
</li>
<li class="md-nav__item">
<a href="cli/named-workspace-custom-layout.html" class="md-nav__link">
<span class="md-ellipsis">
named-workspace-custom-layout
</span>
</a>
</li>
<li class="md-nav__item">
<a href="cli/workspace-layout-rule.html" class="md-nav__link">
@@ -3603,48 +3472,6 @@
<li class="md-nav__item">
<a href="cli/workspace-custom-layout-rule.html" class="md-nav__link">
<span class="md-ellipsis">
workspace-custom-layout-rule
</span>
</a>
</li>
<li class="md-nav__item">
<a href="cli/named-workspace-custom-layout-rule.html" class="md-nav__link">
<span class="md-ellipsis">
named-workspace-custom-layout-rule
</span>
</a>
</li>
<li class="md-nav__item">
<a href="cli/clear-workspace-layout-rules.html" class="md-nav__link">
@@ -3771,6 +3598,69 @@
<li class="md-nav__item">
<a href="cli/toggle-float-override.html" class="md-nav__link">
<span class="md-ellipsis">
toggle-float-override
</span>
</a>
</li>
<li class="md-nav__item">
<a href="cli/toggle-workspace-window-container-behaviour.html" class="md-nav__link">
<span class="md-ellipsis">
toggle-workspace-window-container-behaviour
</span>
</a>
</li>
<li class="md-nav__item">
<a href="cli/toggle-workspace-float-override.html" class="md-nav__link">
<span class="md-ellipsis">
toggle-workspace-float-override
</span>
</a>
</li>
<li class="md-nav__item">
<a href="cli/toggle-pause.html" class="md-nav__link">
@@ -4108,11 +3998,11 @@
<li class="md-nav__item">
<a href="cli/float-rule.html" class="md-nav__link">
<a href="cli/ignore-rule.html" class="md-nav__link">
<span class="md-ellipsis">
float-rule
ignore-rule
</span>
@@ -4674,48 +4564,6 @@
<li class="md-nav__item">
<a href="cli/focus-follows-mouse.html" class="md-nav__link">
<span class="md-ellipsis">
focus-follows-mouse
</span>
</a>
</li>
<li class="md-nav__item">
<a href="cli/toggle-focus-follows-mouse.html" class="md-nav__link">
<span class="md-ellipsis">
toggle-focus-follows-mouse
</span>
</a>
</li>
<li class="md-nav__item">
<a href="cli/mouse-follows-focus.html" class="md-nav__link">
@@ -4801,11 +4649,11 @@
<li class="md-nav__item">
<a href="cli/format-app-specific-configuration.html" class="md-nav__link">
<a href="cli/convert-app-specific-configuration.html" class="md-nav__link">
<span class="md-ellipsis">
format-app-specific-configuration
convert-app-specific-configuration
</span>
@@ -5171,6 +5019,15 @@
<nav class="md-nav" aria-label="whkdrc">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#configuration" class="md-nav__link">
<span class="md-ellipsis">
Configuration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#setting-shell" class="md-nav__link">
<span class="md-ellipsis">
@@ -5272,8 +5129,8 @@ the example files have been downloaded. For most new users this will be in the
seven preconfigured workspaces on the primary monitor each with a different
layout.</p>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;$schema&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;https://raw.githubusercontent.com/LGUG2Z/komorebi/v0.1.29/schema.json&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;app_specific_configuration_path&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;$Env:USERPROFILE/applications.yaml&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;$schema&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;https://raw.githubusercontent.com/LGUG2Z/komorebi/v0.1.30/schema.json&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;app_specific_configuration_path&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;$Env:USERPROFILE/applications.json&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;window_hiding_behaviour&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Cloak&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;cross_monitor_move_behaviour&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Insert&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;default_workspace_padding&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">20</span><span class="p">,</span>
@@ -5352,7 +5209,7 @@ using <code>default_workspace_padding</code> and <code>default_container_padding
<h3 id="active-window-border">Active window border</h3>
<p>You may have seen videos and screenshots of people using <code>komorebi</code> with a
thick, colourful active window border. You can also enable this by setting
<code>active_window_border</code> to <code>true</code>. However, please be warned that this feature
<code>border</code> to <code>true</code>. However, please be warned that this feature
is a crude hack trying to compensate for the insistence of Microsoft Windows
design teams to make custom borders with widths that are actually visible to
the user a thing of the past and removing this capability from the Win32 API.</p>
@@ -5421,6 +5278,7 @@ monocle.</p>
</code></pre></div>
<h3 id="grid">Grid</h3>
<p>If you like the <code>grid</code> layout in <a href="https://github.com/leftwm/leftwm-layouts">LeftWM</a> this is almost exactly the same!</p>
<p>The <code>grid</code> layout does not support resizing windows tiles.</p>
<div class="highlight"><pre><span></span><code>+-----+-----+ +---+---+---+ +---+---+---+ +---+---+---+
| | | | | | | | | | | | | | |
| | | | | | | | | | | | | +---+
@@ -5433,7 +5291,7 @@ monocle.</p>
<h2 id="whkdrc">whkdrc</h2>
<p><code>whkd</code> is a fairly basic piece of software with a simple configuration format:
key bindings go to the left of the colon, and shell commands go to the right of the
colon. By default, the <code>whkdrc</code> file should be located in the <code>$Env:USERPROFILE/.config/</code> directory.</p>
colon.</p>
<p>Please remember that <code>whkd</code> does not support overriding Microsoft's limitations
on hotkey bindings that include the <code>Windows</code> key. If this is important to you,
I recommend using <a href="https://autohotkey.com">AutoHotKey</a> to set up your key
@@ -5515,6 +5373,21 @@ alt + shift + 6 : komorebic move-to-workspace 5
alt + shift + 7 : komorebic move-to-workspace 6
alt + shift + 8 : komorebic move-to-workspace 7
</code></pre></div>
<h3 id="configuration">Configuration</h3>
<p><code>whkd</code> searches for a <code>whkdrc</code> configuration file in the following locations:</p>
<ul>
<li><code>$Env:WHKD_CONFIG_HOME</code></li>
<li><code>$Env:USERPROFILE/.config</code></li>
</ul>
<p>It is also possible to change a hotkey behavior depending on which application has focus:</p>
<div class="highlight"><pre><span></span><code>alt + n [
# ProcessName as shown by `Get-Process`
Firefox : echo &quot;hello firefox&quot;
# Spaces are fine, no quotes required
Google Chrome : echo &quot;hello chrome&quot;
]
</code></pre></div>
<h3 id="setting-shell">Setting .shell</h3>
<p>There is one special directive at the top of the file, <code>.shell</code> which can be
set to either <code>powershell</code>, <code>pwsh</code> or <code>cmd</code>. Which one you use will depend on
@@ -5546,7 +5419,7 @@ the sample configuration above.</p>
<p>The example status bar configuration sets some sane defaults and provides
a number of pre-configured widgets on the primary monitor.</p>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;$schema&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;https://raw.githubusercontent.com/LGUG2Z/komorebi/v0.1.29/schema.bar.json&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;$schema&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;https://raw.githubusercontent.com/LGUG2Z/komorebi/v0.1.30/schema.bar.json&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;monitor&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;index&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;work_area_offset&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>