starred/komorebi
1
0
Fork 0
mirror of https://github.com/LGUG2Z/komorebi.git synced 2026-06-10 12:42:47 +02:00
Code Issues 87 Packages Projects Releases 11 Wiki Activity

Deployed 818ac34 with MkDocs version: 1.5.3

Browse Source
This commit is contained in:
LGUG2Z
2024-09-27 22:07:00 -07:00
parent 133875f4ed
commit 3efcb5be17
181 changed files with 77866 additions and 7226 deletions
Download Patch File Download Diff File Expand all files Collapse all files
example-configurations.html
+373 -55
View File
@@ -767,6 +767,30 @@
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#komorebibarjson" class="md-nav__link">
<span class="md-ellipsis">
komorebi.bar.json
</span>
</a>
<nav class="md-nav" aria-label="komorebi.bar.json">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#themes" class="md-nav__link">
<span class="md-ellipsis">
Themes
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
@@ -1563,6 +1587,22 @@
@@ -1720,6 +1760,27 @@
<li class="md-nav__item">
<a href="cli/bar-configuration.html" class="md-nav__link">
<span class="md-ellipsis">
bar-configuration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="cli/whkdrc.html" class="md-nav__link">
@@ -2224,6 +2285,69 @@
<li class="md-nav__item">
<a href="cli/unstack.html" class="md-nav__link">
<span class="md-ellipsis">
unstack
</span>
</a>
</li>
<li class="md-nav__item">
<a href="cli/cycle-stack.html" class="md-nav__link">
<span class="md-ellipsis">
cycle-stack
</span>
</a>
</li>
<li class="md-nav__item">
<a href="cli/focus-stack-window.html" class="md-nav__link">
<span class="md-ellipsis">
focus-stack-window
</span>
</a>
</li>
<li class="md-nav__item">
<a href="cli/stack-all.html" class="md-nav__link">
@@ -2308,48 +2432,6 @@
<li class="md-nav__item">
<a href="cli/unstack.html" class="md-nav__link">
<span class="md-ellipsis">
unstack
</span>
</a>
</li>
<li class="md-nav__item">
<a href="cli/cycle-stack.html" class="md-nav__link">
<span class="md-ellipsis">
cycle-stack
</span>
</a>
</li>
<li class="md-nav__item">
<a href="cli/move-to-monitor.html" class="md-nav__link">
@@ -3820,6 +3902,27 @@
<li class="md-nav__item">
<a href="cli/replace-configuration.html" class="md-nav__link">
<span class="md-ellipsis">
replace-configuration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="cli/reload-configuration.html" class="md-nav__link">
@@ -4429,6 +4532,111 @@
<li class="md-nav__item">
<a href="cli/toggle-transparency.html" class="md-nav__link">
<span class="md-ellipsis">
toggle-transparency
</span>
</a>
</li>
<li class="md-nav__item">
<a href="cli/animation.html" class="md-nav__link">
<span class="md-ellipsis">
animation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="cli/animation-duration.html" class="md-nav__link">
<span class="md-ellipsis">
animation-duration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="cli/animation-fps.html" class="md-nav__link">
<span class="md-ellipsis">
animation-fps
</span>
</a>
</li>
<li class="md-nav__item">
<a href="cli/animation-style.html" class="md-nav__link">
<span class="md-ellipsis">
animation-style
</span>
</a>
</li>
<li class="md-nav__item">
<a href="cli/focus-follows-mouse.html" class="md-nav__link">
@@ -4947,6 +5155,30 @@
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#komorebibarjson" class="md-nav__link">
<span class="md-ellipsis">
komorebi.bar.json
</span>
</a>
<nav class="md-nav" aria-label="komorebi.bar.json">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#themes" class="md-nav__link">
<span class="md-ellipsis">
Themes
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
@@ -4994,15 +5226,16 @@ the example files have been downloaded. For most new users this will be in the
<code>$Env:USERPROFILE</code> directory.</p>
<div class="highlight"><pre><span></span><code><span class="n">komorebic</span> <span class="n">quickstart</span>
</code></pre></div>
<p>With the example configurations downloaded, you can now start <code>komorebi</code> and `whkd.</p>
<div class="highlight"><pre><span></span><code><span class="n">komorebic</span> <span class="nb">start </span><span class="p">-</span><span class="n">-whkd</span>
<p>With the example configurations downloaded, you can now start <code>komorebi</code>,
<code>komorebi-bar</code> and <code>whkd</code>.</p>
<div class="highlight"><pre><span></span><code><span class="n">komorebic</span> <span class="nb">start </span><span class="p">-</span><span class="n">-whkd</span> <span class="p">-</span><span class="n">-bar</span>
</code></pre></div>
<h2 id="komorebijson">komorebi.json</h2>
<p>The example window manager configuration sets some sane defaults and provides
five preconfigured workspaces on the primary monitor each with a different
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.28/schema.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.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;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>
@@ -5011,20 +5244,17 @@ layout.</p>
<span class="w"> </span><span class="nt">&quot;border&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;border_width&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">8</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;border_offset&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">-1</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;border_colours&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;single&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;#42a5f5&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;stack&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;#00a542&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;monocle&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;#ff3399&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;unfocused&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;#808080&quot;</span>
<span class="w"> </span><span class="nt">&quot;theme&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;palette&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Base16&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Ashes&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;unfocused_border&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Base03&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;bar_accent&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Base0D&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="nt">&quot;stackbar&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;height&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">40</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;mode&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;OnStack&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;tabs&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;width&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">300</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;focused_text&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;#00a542&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;unfocused_text&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;#b3b3b3&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;background&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;#141414&quot;</span>
<span class="w"> </span><span class="nt">&quot;width&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">300</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="nt">&quot;monitors&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
@@ -5275,6 +5505,94 @@ reference.</p>
<p>If you want to use one of those key codes, put them into lower case and remove
the <code>VK_</code> prefix. For example, the keycode <code>VK_OEM_PLUS</code> becomes <code>oem_plus</code> in
the sample configuration above.</p>
<h2 id="komorebibarjson">komorebi.bar.json</h2>
<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;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>
<span class="w"> </span><span class="nt">&quot;left&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;top&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">40</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;right&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;bottom&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">40</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="nt">&quot;font_family&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;JetBrains Mono&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;theme&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;palette&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Base16&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Ashes&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;accent&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Base0D&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="nt">&quot;left_widgets&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;Komorebi&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;workspaces&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;enable&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;hide_empty_workspaces&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="nt">&quot;layout&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;enable&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="nt">&quot;focused_window&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;enable&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;show_icon&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">],</span>
<span class="w"> </span><span class="nt">&quot;right_widgets&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;Media&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;enable&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;Storage&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;enable&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;Memory&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;enable&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;Network&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;enable&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;show_total_data_transmitted&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;show_network_activity&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;Date&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;enable&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;format&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;DayDateMonthYear&quot;</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;Time&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;enable&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;format&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;TwentyFourHour&quot;</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;Battery&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;enable&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">]</span>
<span class="p">}</span>
</code></pre></div>
<h3 id="themes">Themes</h3>
<p>Themes can be set in either <code>komorebi.json</code> or <code>komorebi.bar.json</code>. If set
in <code>komorebi.json</code>, the theme will be applied to both komorebi's borders and
stackbars as well as the status bar.</p>
<p>If set in <code>komorebi.bar.json</code>, the theme will only be applied to the status bar.</p>
<p>All <a href="https://catppuccin.com/">Catppuccin palette variants</a>
and <a href="https://tinted-theming.github.io/base16-gallery/">most Base16 palette variants</a>
are available as themes.</p>