Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tekezo committed Aug 9, 2024
1 parent be16ae5 commit 43aebbc
Show file tree
Hide file tree
Showing 119 changed files with 264 additions and 274 deletions.
2 changes: 1 addition & 1 deletion docs/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@
aria-label="Search this site…"
autocomplete="off"

data-offline-search-index-json-src="/offline-search-index.7807772b4f01f8e6f5e7a25b2274e3f7.json"
data-offline-search-index-json-src="/offline-search-index.43a1d83ff36e29d62b5b07be4c12d599.json"
data-offline-search-base-href="/"
data-offline-search-max-results="25"
>
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/contact/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@
aria-label="Search this site…"
autocomplete="off"

data-offline-search-index-json-src="/offline-search-index.7807772b4f01f8e6f5e7a25b2274e3f7.json"
data-offline-search-index-json-src="/offline-search-index.43a1d83ff36e29d62b5b07be4c12d599.json"
data-offline-search-base-href="/"
data-offline-search-max-results="25"
>
Expand All @@ -124,7 +124,7 @@
aria-label="Search this site…"
autocomplete="off"

data-offline-search-index-json-src="/offline-search-index.7807772b4f01f8e6f5e7a25b2274e3f7.json"
data-offline-search-index-json-src="/offline-search-index.43a1d83ff36e29d62b5b07be4c12d599.json"
data-offline-search-base-href="/"
data-offline-search-max-results="25"
>
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/getting-started/features/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@
aria-label="Search this site…"
autocomplete="off"

data-offline-search-index-json-src="/offline-search-index.7807772b4f01f8e6f5e7a25b2274e3f7.json"
data-offline-search-index-json-src="/offline-search-index.43a1d83ff36e29d62b5b07be4c12d599.json"
data-offline-search-base-href="/"
data-offline-search-max-results="25"
>
Expand All @@ -112,7 +112,7 @@
aria-label="Search this site…"
autocomplete="off"

data-offline-search-index-json-src="/offline-search-index.7807772b4f01f8e6f5e7a25b2274e3f7.json"
data-offline-search-index-json-src="/offline-search-index.43a1d83ff36e29d62b5b07be4c12d599.json"
data-offline-search-base-href="/"
data-offline-search-max-results="25"
>
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/getting-started/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@
aria-label="Search this site…"
autocomplete="off"

data-offline-search-index-json-src="/offline-search-index.7807772b4f01f8e6f5e7a25b2274e3f7.json"
data-offline-search-index-json-src="/offline-search-index.43a1d83ff36e29d62b5b07be4c12d599.json"
data-offline-search-base-href="/"
data-offline-search-max-results="25"
>
Expand All @@ -107,7 +107,7 @@
aria-label="Search this site…"
autocomplete="off"

data-offline-search-index-json-src="/offline-search-index.7807772b4f01f8e6f5e7a25b2274e3f7.json"
data-offline-search-index-json-src="/offline-search-index.43a1d83ff36e29d62b5b07be4c12d599.json"
data-offline-search-base-href="/"
data-offline-search-max-results="25"
>
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/getting-started/index.xml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<link>/docs/getting-started/installation/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/docs/getting-started/installation/</guid>
<description>Some operations are required to grant proper permission from macOS to Karabiner-Elements. Follow these instructions to set up Karabiner-Elements.&#xA;Install Karabiner-Elements Open the downloaded file. Open the .pkg file. The installer will be opened. Install Karabiner-Elements. Keep Login Items enabled Since macOS 13 Ventura, background item notifications will be shown after the installation.&#xA;The following Login Items in System Settings are required, and have to keep enabled.&#xA;Karabiner-DriverKit-VirtualHIDDeviceClient.app Karabiner-Elements.app Note If you are using macOS 12 or prior, these items are not shown in System Preferences.</description>
<description>Some operations are required to grant proper permission from macOS to Karabiner-Elements. Follow these instructions to set up Karabiner-Elements.&#xA;Install Karabiner-Elements Open the downloaded file. Open the .pkg file. The installer will be opened. Install Karabiner-Elements. After installation, you’ll need to grant the necessary permissions for Karabiner-Elements to function. This is part of macOS&amp;rsquo;s protection mechanism to prevent applications from accessing information without user consent. There are a few required steps, so please follow the instructions.</description>
</item>
<item>
<title>Features</title>
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/docs/getting-started/installation/images/[email protected]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/docs/getting-started/installation/images/[email protected]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/docs/getting-started/installation/images/[email protected]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
104 changes: 47 additions & 57 deletions docs/docs/getting-started/installation/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,35 +19,27 @@

<title>Installation | Karabiner-Elements</title>
<meta name="description" content="Some operations are required to grant proper permission from macOS to Karabiner-Elements. Follow these instructions to set up Karabiner-Elements.
Install Karabiner-Elements Open the downloaded file. Open the .pkg file. The installer will be opened. Install Karabiner-Elements. Keep Login Items enabled Since macOS 13 Ventura, background item notifications will be shown after the installation.
The following Login Items in System Settings are required, and have to keep enabled.
Karabiner-DriverKit-VirtualHIDDeviceClient.app Karabiner-Elements.app Note If you are using macOS 12 or prior, these items are not shown in System Preferences.">
Install Karabiner-Elements Open the downloaded file. Open the .pkg file. The installer will be opened. Install Karabiner-Elements. After installation, you’ll need to grant the necessary permissions for Karabiner-Elements to function. This is part of macOS&amp;rsquo;s protection mechanism to prevent applications from accessing information without user consent. There are a few required steps, so please follow the instructions.">
<meta property="og:url" content="/docs/getting-started/installation/">
<meta property="og:site_name" content="Karabiner-Elements">
<meta property="og:title" content="Installation">
<meta property="og:description" content="Some operations are required to grant proper permission from macOS to Karabiner-Elements. Follow these instructions to set up Karabiner-Elements.
Install Karabiner-Elements Open the downloaded file. Open the .pkg file. The installer will be opened. Install Karabiner-Elements. Keep Login Items enabled Since macOS 13 Ventura, background item notifications will be shown after the installation.
The following Login Items in System Settings are required, and have to keep enabled.
Karabiner-DriverKit-VirtualHIDDeviceClient.app Karabiner-Elements.app Note If you are using macOS 12 or prior, these items are not shown in System Preferences.">
Install Karabiner-Elements Open the downloaded file. Open the .pkg file. The installer will be opened. Install Karabiner-Elements. After installation, you’ll need to grant the necessary permissions for Karabiner-Elements to function. This is part of macOS’s protection mechanism to prevent applications from accessing information without user consent. There are a few required steps, so please follow the instructions.">
<meta property="og:locale" content="en">
<meta property="og:type" content="article">
<meta property="article:section" content="docs">
<meta property="og:image" content="https://karabiner-elements.pqrs.org/images/logo.png">

<meta itemprop="name" content="Installation">
<meta itemprop="description" content="Some operations are required to grant proper permission from macOS to Karabiner-Elements. Follow these instructions to set up Karabiner-Elements.
Install Karabiner-Elements Open the downloaded file. Open the .pkg file. The installer will be opened. Install Karabiner-Elements. Keep Login Items enabled Since macOS 13 Ventura, background item notifications will be shown after the installation.
The following Login Items in System Settings are required, and have to keep enabled.
Karabiner-DriverKit-VirtualHIDDeviceClient.app Karabiner-Elements.app Note If you are using macOS 12 or prior, these items are not shown in System Preferences.">
<meta itemprop="wordCount" content="227">
Install Karabiner-Elements Open the downloaded file. Open the .pkg file. The installer will be opened. Install Karabiner-Elements. After installation, you’ll need to grant the necessary permissions for Karabiner-Elements to function. This is part of macOS’s protection mechanism to prevent applications from accessing information without user consent. There are a few required steps, so please follow the instructions.">
<meta itemprop="wordCount" content="296">
<meta itemprop="image" content="https://karabiner-elements.pqrs.org/images/logo.png">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:image" content="https://karabiner-elements.pqrs.org/images/logo.png">
<meta name="twitter:title" content="Installation">
<meta name="twitter:description" content="Some operations are required to grant proper permission from macOS to Karabiner-Elements. Follow these instructions to set up Karabiner-Elements.
Install Karabiner-Elements Open the downloaded file. Open the .pkg file. The installer will be opened. Install Karabiner-Elements. Keep Login Items enabled Since macOS 13 Ventura, background item notifications will be shown after the installation.
The following Login Items in System Settings are required, and have to keep enabled.
Karabiner-DriverKit-VirtualHIDDeviceClient.app Karabiner-Elements.app Note If you are using macOS 12 or prior, these items are not shown in System Preferences.">
Install Karabiner-Elements Open the downloaded file. Open the .pkg file. The installer will be opened. Install Karabiner-Elements. After installation, you’ll need to grant the necessary permissions for Karabiner-Elements to function. This is part of macOS’s protection mechanism to prevent applications from accessing information without user consent. There are a few required steps, so please follow the instructions.">



Expand Down Expand Up @@ -96,7 +88,7 @@
aria-label="Search this site…"
autocomplete="off"

data-offline-search-index-json-src="/offline-search-index.7807772b4f01f8e6f5e7a25b2274e3f7.json"
data-offline-search-index-json-src="/offline-search-index.43a1d83ff36e29d62b5b07be4c12d599.json"
data-offline-search-base-href="/"
data-offline-search-max-results="25"
>
Expand All @@ -120,7 +112,7 @@
aria-label="Search this site…"
autocomplete="off"

data-offline-search-index-json-src="/offline-search-index.7807772b4f01f8e6f5e7a25b2274e3f7.json"
data-offline-search-index-json-src="/offline-search-index.43a1d83ff36e29d62b5b07be4c12d599.json"
data-offline-search-base-href="/"
data-offline-search-max-results="25"
>
Expand Down Expand Up @@ -630,8 +622,8 @@
<nav id="TableOfContents">
<ul>
<li><a href="#install-karabiner-elements">Install Karabiner-Elements</a></li>
<li><a href="#keep-login-items-enabled">Keep Login Items enabled</a></li>
<li><a href="#open-karabiner-elements-settings">Open Karabiner-Elements Settings</a></li>
<li><a href="#keep-login-items-enabled">Keep Login Items enabled</a></li>
<li><a href="#allow-system-software-which-provides-virtual-devices-for-karabiner-elements">Allow system software which provides virtual devices for Karabiner-Elements</a></li>
<li><a href="#grant-input-monitoring-to-karabiner-elements-processes">Grant Input Monitoring to Karabiner-Elements processes</a></li>
<li><a href="#setup-your-keyboard-layout">Setup your keyboard layout</a></li>
Expand Down Expand Up @@ -690,8 +682,31 @@ <h2 id="install-karabiner-elements">Install Karabiner-Elements</h2>
</figure>
</li>
</ol>
<p>After installation, you’ll need to grant the necessary permissions for Karabiner-Elements to function.
This is part of macOS&rsquo;s protection mechanism to prevent applications from accessing information without user consent.
There are a few required steps, so please follow the instructions.</p>
<p>Additionally, when you open Karabiner-Elements Settings, the necessary actions will be displayed, so you can follow those prompts as well.</p>
<h2 id="open-karabiner-elements-settings">Open Karabiner-Elements Settings</h2>
<ol>
<li>Open Karabiner-Elements from Launchpad.







<figure>
<img
src="/docs/getting-started/installation/images/[email protected]"
alt="[email protected]"
style="width: 537px"
/>
</figure>
</li>
</ol>
<h2 id="keep-login-items-enabled">Keep Login Items enabled</h2>
<p>Since macOS 13 Ventura, background item notifications will be shown after the installation.</p>
<p>The background item notifications will be shown after the installation.</p>



Expand All @@ -703,14 +718,14 @@ <h2 id="keep-login-items-enabled">Keep Login Items enabled</h2>
<img
src="/docs/getting-started/installation/images/[email protected]"
alt="[email protected]"
style="width: 464px"
style="width: 465px"
/>
</figure>

<p>The following Login Items in System Settings are required, and have to keep enabled.</p>
<p>The following Login Items in System Settings must be enabled.</p>
<ul>
<li><code>Karabiner-DriverKit-VirtualHIDDeviceClient.app</code></li>
<li><code>Karabiner-Elements.app</code></li>
<li><code>Karabiner-Elements Non-Privileged Agents</code></li>
<li><code>Karabiner-Elements Privileged Daemons</code></li>
</ul>


Expand All @@ -737,25 +752,6 @@ <h4 class="alert-heading">Note</h4>

</div>

<h2 id="open-karabiner-elements-settings">Open Karabiner-Elements Settings</h2>
<ol>
<li>Open Karabiner-Elements from Launchpad.







<figure>
<img
src="/docs/getting-started/installation/images/[email protected]"
alt="[email protected]"
style="width: 537px"
/>
</figure>
</li>
</ol>
<h2 id="allow-system-software-which-provides-virtual-devices-for-karabiner-elements">Allow system software which provides virtual devices for Karabiner-Elements</h2>
<ol>
<li>The following alert will be shown when you open Karabiner-Elements Settings.</li>
Expand Down Expand Up @@ -802,7 +798,7 @@ <h4 class="alert-heading">Note</h4>

<h2 id="grant-input-monitoring-to-karabiner-elements-processes">Grant Input Monitoring to Karabiner-Elements processes</h2>
<ol>
<li><strong>Two Keystroke Receiving</strong> alerts will be shown on macOS Catalina or later after you allow the system software.</li>
<li>The <strong>Keystroke Receiving</strong> alerts will be shown.</li>
<li>Press the <strong>Open System Settings</strong> button on both alerts.


Expand All @@ -818,24 +814,9 @@ <h2 id="grant-input-monitoring-to-karabiner-elements-processes">Grant Input Moni
style="width: 461px"
/>
</figure>








<figure>
<img
src="/docs/getting-started/installation/images/[email protected]"
alt="[email protected]"
style="width: 461px"
/>
</figure>
</li>
<li>System Settings will be opened after you press the <strong>Open System Settings</strong> button.<br/>
Choose <strong>Privacy &amp; Security &gt; Input Monitoring</strong>, and then enable <strong>karabiner_grabber</strong> and <strong>karabiner_observer</strong>. <br />
Choose <strong>Privacy &amp; Security &gt; Input Monitoring</strong>, and then enable <strong>karabiner_grabber</strong>.<br />



Expand All @@ -852,6 +833,15 @@ <h2 id="grant-input-monitoring-to-karabiner-elements-processes">Grant Input Moni
</figure>
</li>
</ol>


<div class="alert alert-primary" role="alert">
<h4 class="alert-heading">Note</h4>

If you are using Karabiner-Elements 14.13.0 or earlier, an alert for karabiner_observer will also be displayed, so please grant permission for that as well.

</div>

<h2 id="setup-your-keyboard-layout">Setup your keyboard layout</h2>
<ol>
<li>Keyboard Setup Assistant will be opened.<br/>
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/help/advanced-topics/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@
aria-label="Search this site…"
autocomplete="off"

data-offline-search-index-json-src="/offline-search-index.7807772b4f01f8e6f5e7a25b2274e3f7.json"
data-offline-search-index-json-src="/offline-search-index.43a1d83ff36e29d62b5b07be4c12d599.json"
data-offline-search-base-href="/"
data-offline-search-max-results="25"
>
Expand All @@ -107,7 +107,7 @@
aria-label="Search this site…"
autocomplete="off"

data-offline-search-index-json-src="/offline-search-index.7807772b4f01f8e6f5e7a25b2274e3f7.json"
data-offline-search-index-json-src="/offline-search-index.43a1d83ff36e29d62b5b07be4c12d599.json"
data-offline-search-base-href="/"
data-offline-search-max-results="25"
>
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/help/advanced-topics/installed-files/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@
aria-label="Search this site…"
autocomplete="off"

data-offline-search-index-json-src="/offline-search-index.7807772b4f01f8e6f5e7a25b2274e3f7.json"
data-offline-search-index-json-src="/offline-search-index.43a1d83ff36e29d62b5b07be4c12d599.json"
data-offline-search-base-href="/"
data-offline-search-max-results="25"
>
Expand All @@ -112,7 +112,7 @@
aria-label="Search this site…"
autocomplete="off"

data-offline-search-index-json-src="/offline-search-index.7807772b4f01f8e6f5e7a25b2274e3f7.json"
data-offline-search-index-json-src="/offline-search-index.43a1d83ff36e29d62b5b07be4c12d599.json"
data-offline-search-base-href="/"
data-offline-search-max-results="25"
>
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/help/advanced-topics/lock-icon/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@
aria-label="Search this site…"
autocomplete="off"

data-offline-search-index-json-src="/offline-search-index.7807772b4f01f8e6f5e7a25b2274e3f7.json"
data-offline-search-index-json-src="/offline-search-index.43a1d83ff36e29d62b5b07be4c12d599.json"
data-offline-search-base-href="/"
data-offline-search-max-results="25"
>
Expand All @@ -120,7 +120,7 @@
aria-label="Search this site…"
autocomplete="off"

data-offline-search-index-json-src="/offline-search-index.7807772b4f01f8e6f5e7a25b2274e3f7.json"
data-offline-search-index-json-src="/offline-search-index.43a1d83ff36e29d62b5b07be4c12d599.json"
data-offline-search-base-href="/"
data-offline-search-max-results="25"
>
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/help/advanced-topics/security/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@
aria-label="Search this site…"
autocomplete="off"

data-offline-search-index-json-src="/offline-search-index.7807772b4f01f8e6f5e7a25b2274e3f7.json"
data-offline-search-index-json-src="/offline-search-index.43a1d83ff36e29d62b5b07be4c12d599.json"
data-offline-search-base-href="/"
data-offline-search-max-results="25"
>
Expand All @@ -128,7 +128,7 @@
aria-label="Search this site…"
autocomplete="off"

data-offline-search-index-json-src="/offline-search-index.7807772b4f01f8e6f5e7a25b2274e3f7.json"
data-offline-search-index-json-src="/offline-search-index.43a1d83ff36e29d62b5b07be4c12d599.json"
data-offline-search-base-href="/"
data-offline-search-max-results="25"
>
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/help/how-to/disable-caps-lock-delay/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@
aria-label="Search this site…"
autocomplete="off"

data-offline-search-index-json-src="/offline-search-index.7807772b4f01f8e6f5e7a25b2274e3f7.json"
data-offline-search-index-json-src="/offline-search-index.43a1d83ff36e29d62b5b07be4c12d599.json"
data-offline-search-base-href="/"
data-offline-search-max-results="25"
>
Expand All @@ -108,7 +108,7 @@
aria-label="Search this site…"
autocomplete="off"

data-offline-search-index-json-src="/offline-search-index.7807772b4f01f8e6f5e7a25b2274e3f7.json"
data-offline-search-index-json-src="/offline-search-index.43a1d83ff36e29d62b5b07be4c12d599.json"
data-offline-search-base-href="/"
data-offline-search-max-results="25"
>
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/help/how-to/disable-open-at-login/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@
aria-label="Search this site…"
autocomplete="off"

data-offline-search-index-json-src="/offline-search-index.7807772b4f01f8e6f5e7a25b2274e3f7.json"
data-offline-search-index-json-src="/offline-search-index.43a1d83ff36e29d62b5b07be4c12d599.json"
data-offline-search-base-href="/"
data-offline-search-max-results="25"
>
Expand All @@ -112,7 +112,7 @@
aria-label="Search this site…"
autocomplete="off"

data-offline-search-index-json-src="/offline-search-index.7807772b4f01f8e6f5e7a25b2274e3f7.json"
data-offline-search-index-json-src="/offline-search-index.43a1d83ff36e29d62b5b07be4c12d599.json"
data-offline-search-base-href="/"
data-offline-search-max-results="25"
>
Expand Down
Loading

0 comments on commit 43aebbc

Please sign in to comment.