Deployed 4b9d811 with MkDocs version: 1.6.1

This commit is contained in:
LGUG2Z
2025-01-01 12:00:42 -08:00
parent 0f95f2eecb
commit a1544f0f3b
182 changed files with 44606 additions and 51 deletions
+217 -6
View File
@@ -71,6 +71,11 @@
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#overview" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
@@ -1318,6 +1323,16 @@
@@ -1431,6 +1446,27 @@
<li class="md-nav__item">
<a href="cli/kill.html" class="md-nav__link">
<span class="md-ellipsis">
kill
</span>
</a>
</li>
<li class="md-nav__item">
<a href="cli/check.html" class="md-nav__link">
@@ -1977,6 +2013,27 @@
<li class="md-nav__item">
<a href="cli/eager-focus.html" class="md-nav__link">
<span class="md-ellipsis">
eager-focus
</span>
</a>
</li>
<li class="md-nav__item">
<a href="cli/stack.html" class="md-nav__link">
@@ -2040,6 +2097,27 @@
<li class="md-nav__item">
<a href="cli/cycle-stack-index.html" class="md-nav__link">
<span class="md-ellipsis">
cycle-stack-index
</span>
</a>
</li>
<li class="md-nav__item">
<a href="cli/focus-stack-window.html" class="md-nav__link">
@@ -2523,6 +2601,27 @@
<li class="md-nav__item">
<a href="cli/close-workspace.html" class="md-nav__link">
<span class="md-ellipsis">
close-workspace
</span>
</a>
</li>
<li class="md-nav__item">
<a href="cli/cycle-monitor.html" class="md-nav__link">
@@ -3930,6 +4029,27 @@
<li class="md-nav__item">
<a href="cli/enforce-workspace-rules.html" class="md-nav__link">
<span class="md-ellipsis">
enforce-workspace-rules
</span>
</a>
</li>
<li class="md-nav__item">
<a href="cli/identify-object-name-change-application.html" class="md-nav__link">
@@ -4600,6 +4720,59 @@
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#overview" class="md-nav__link">
<span class="md-ellipsis">
Overview
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#community" class="md-nav__link">
<span class="md-ellipsis">
Community
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#licensing-for-personal-use" class="md-nav__link">
<span class="md-ellipsis">
Licensing for Personal Use
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#sponsorship-for-personal-use" class="md-nav__link">
<span class="md-ellipsis">
Sponsorship for Personal Use
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#licensing-for-commercial-use" class="md-nav__link">
<span class="md-ellipsis">
Licensing for Commercial Use
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
@@ -4632,6 +4805,7 @@
<h1>Index</h1>
<p><img alt="screenshot" src="https://user-images.githubusercontent.com/13164844/184027064-f5a6cec2-2865-4d65-a549-a1f1da589abf.png" /></p>
<h2 id="overview">Overview</h2>
<p><code>komorebi</code> is a tiling window manager that works as an extension to Microsoft's
<a href="https://docs.microsoft.com/en-us/windows/win32/dwm/dwm-overview">Desktop Window
Manager</a> in
@@ -4644,13 +4818,50 @@ keyboard shortcuts.</p>
system and desktop environment by default. Users are free to make such
modifications in their own configuration files for <code>komorebi</code>, but these will
always remain opt-in and off-by-default.</p>
<h2 id="community">Community</h2>
<p>There is a <a href="https://discord.gg/mGkn66PHkx">Discord server</a> available for
<code>komorebi</code>-related discussion, help, troubleshooting etc. If you have any
specific feature requests or bugs to report, please create an issue on
<a href="https://github.com/LGUG2Z/komorebi">GitHub</a>.</p>
<p>There is also a <a href="https://www.youtube.com/channel/UCeai3-do-9O4MNy9_xjO6mg?sub_confirmation=1">YouTube
channel</a>
where I share <code>komorebi</code> live programming videos and tutorial videos.</p>
<code>komorebi</code>-related discussion, help, troubleshooting etc.</p>
<p>There is a <a href="https://www.youtube.com/channel/UCeai3-do-9O4MNy9_xjO6mg">YouTube
channel</a> where I post
<code>komorebi</code> development videos, feature previews and release overviews. Subscribing
to the channel (which is monetized as part of the YouTube Partner Program) and
watching videos is a really simple and passive way to contribute financially to
the development and maintenance of <code>komorebi</code>.</p>
<p>There is an <a href="https://github.com/LGUG2Z/awesome-komorebi">Awesome List</a> which
showcases the many awesome projects that exist in the <code>komorebi</code> ecosystem.</p>
<h2 id="licensing-for-personal-use">Licensing for Personal Use</h2>
<p><code>komorebi</code> is licensed under the <a href="https://github.com/LGUG2Z/komorebi-license">Komorebi 1.0.0 license</a>, which is a fork
of the <a href="https://polyformproject.org/licenses/strict/1.0.0">PolyForm Strict 1.0.0 license</a>. On a high level this means
that you are free to do whatever you want with <code>komorebi</code> for personal use other than redistribution, or distribution of
new works (i.e. hard-forks) based on the software.</p>
<p>Anyone is free to make their own fork of <code>komorebi</code> with changes intended either for personal use or for integration
back upstream via pull requests.</p>
<p>The <a href="https://github.com/LGUG2Z/komorebi-license">Komorebi 1.0.0 License</a> does not permit any kind of commercial use (
i.e. using <code>komorebi</code> at work).</p>
<h2 id="sponsorship-for-personal-use">Sponsorship for Personal Use</h2>
<p><code>komorebi</code> is a free and educational source project, and one that encourages you
to make charitable donations if you find the software to be useful and have the
financial means.</p>
<p>I encourage you to make a charitable donation to the <a href="https://pcrf1.app.neoncrm.com/forms/gaza-recovery">Palestine Children's
Relief Fund</a> or to contribute
to a <a href="https://gazafunds.com">Gaza Funds campaign</a> before you consider sponsoring
me on GitHub.</p>
<p><a href="https://github.com/sponsors/LGUG2Z">GitHub Sponsors is enabled for this
project</a>. Sponsors can claim custom roles on
the Discord server, get shout-outs at the end of <em>komorebi</em>-related videos on
YouTube, and gain the ability to submit feature requests on the issue tracker.</p>
<p>If you would like to tip or sponsor the project but are unable to use GitHub
Sponsors, you may also sponsor through <a href="https://ko-fi.com/lgug2z">Ko-fi</a>, or
make an anonymous Bitcoin donation to <code>bc1qv73wzspc77k46uty4vp85x8sdp24mphvm58f6q</code>.</p>
<h2 id="licensing-for-commercial-use">Licensing for Commercial Use</h2>
<p>A dedicated Individual Commercial Use License is available for those who want to
use <code>komorebi</code> at work.</p>
<p>The Individual Commerical Use License adds “Commercial Use” as a “Permitted Use”
for the licensed individual only, for the duration of a valid paid license
subscription only. All provisions and restrictions enumerated in the <a href="https://github.com/LGUG2Z/komorebi-license">Komorebi
License</a> continue to apply.</p>
<p>More information, pricing and purchase links for Individual Commercial Use
Licenses <a href="https://lgug2z.com/software/komorebi">can be found here</a>.</p>