Skip to content

Commit 677d6df

Browse files
committed
adjust documentation img structure
1 parent f61ede6 commit 677d6df

File tree

8 files changed

+20
-19
lines changed

8 files changed

+20
-19
lines changed

.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
design/
2+
3+
14
GALLERY.md
25

36
# Created by .ignore support plugin (hsz.mobi)

README.md

+13-15
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,11 @@
22

33
*Make CapsLock Great Again!* [![Visits Badge](https://badges.pufler.dev/visits/Vonng/Capslock)](https://badges.pufler.dev)
44

5-
[![](images/logo.svg)](http://capslock.vonng.com)
5+
![](docs/img/logo.svg)
66

77
*Transform <kbd>⇪</kbd>CapsLock into a powerful **modifier** **<kbd>✱</kbd> Hyper** that miraculously increases your work productivity!*
88

9-
[**Capslock Website**](http://capslock.vonng.com/en/) / [**ZH Site**](http://capslock.vonng.com/zh/)
10-
11-
[**Chinese Documentation 中文文档** ](README_ZH.md)
9+
[**zh-cn docs 中文文档** ](README_ZH.md)
1210

1311
[**Karabiner-Elements Official Gallery**](https://ke-complex-modifications.pqrs.org/#emulation-modes)
1412

@@ -57,7 +55,7 @@ Capslock serves via [**Karabiner-Elements**](https://karabiner-elements.pqrs.or
5755
Or just open this link with Safari to launch karabiner and load config from URL:
5856

5957
```yaml
60-
karabiner://karabiner/assets/complex_modifications/import?url=https://vonng.com/capslock.json
58+
karabiner://karabiner/assets/complex_modifications/import?url=https://github.com/Vonng/Capslock/blob/master/mac_v3/capslock.json
6159
```
6260

6361
Or check karabiner official [gallery](https://ke-complex-modifications.pqrs.org/#emulation-modes) and load it there.
@@ -70,7 +68,7 @@ Capslock serves via [**Karabiner-Elements**](https://karabiner-elements.pqrs.or
7068

7169
Capslock works on **ANSI** keyboards and similar layouts. It literally remaps every [**keys**](#Symbols) on the keyboard. Including 10 categories.
7270

73-
![](images/keyboard.png)
71+
![](docs/img/keyboard.png)
7472

7573
> **[Control Planes](#Control-Planes)** are defined by combination of four extra left modifiers: <kbd>⌘</kbd><kbd>⌥</kbd><kbd>⌃</kbd><kbd>⇧</kbd>.This image shows the layout of control plane 0.
7674
@@ -107,7 +105,7 @@ Hold **<kbd>✱</kbd> Hyper** to enable hyper functionalities. We will assume a
107105
* Hold additional <kbd>⌘</kbd> Command for **selection**. (like holding <kbd>⇧</kbd>shift in normal), additional <kbd>⌥</kbd> Option for **word/para selection**.
108106
* Hold additional <kbd>⇧</kbd> Shift for **app/win/tab switching**. Hold additional <kbd>⌃</kbd> Control for **desktop management** .
109107
* Hold additional <kbd>⌥</kbd> Option for 🖱️ **mouse move**. Add <kbd>⇧</kbd>shift to **⏫ accelerate**. (<kbd>U</kbd>, <kbd>I</kbd>, <kbd>O</kbd>, <kbd>P</kbd> maps to mouse buttons) .
110-
* <kbd>⇧</kbd><kbd>⌥</kbd> turns navigator to **🖲️ mouse wheel**, and <kbd>⇧</kbd><kbd>⌘</kbd> is the ⏫ **accelerated** version . `HJKL` for wheel, wihle `UIOP` for reversed wheel move.
108+
* <kbd>⇧</kbd><kbd>⌥</kbd> turns navigator to **🖲️ mouse wheel**, and <kbd>⇧</kbd><kbd>⌘</kbd> is the ⏫ **accelerated** version . `HJKL` for wheel, while `UIOP` for reversed wheel move.
111109

112110
| Feature | **Move** | **Select** | **WordSel** | **Window** | **Desktop** | 🖱️ | **🖱️⏫** | 🖲️ | 🖲️⏫ |
113111
| :-----: | :------: | :--------: | :---------: | :--------: | :---------: | :--: | :----: | :--: | :--: |
@@ -128,7 +126,7 @@ Hold **<kbd>✱</kbd> Hyper** to enable hyper functionalities. We will assume a
128126

129127
* Arrows <kbd>←</kbd>↓<kbd>↑</kbd>→ to 🖱️ **mouse** actions too. Hold <kbd>⌥</kbd> Option to ⏬ **slow down**, hold <kbd>⌘</kbd> Command to ⏫ **speed up**.
130128
* Hold <kbd>⇧</kbd> Shift turns to 🖲️ **wheel move**. Extra <kbd>⌥</kbd> Option to ⏬ **slow down**, extra <kbd>⌘</kbd> Command to ⏫ **speed up**.
131-
* <kbd>↩</kbd> Return maps to left **click**. And additional <kbd>⌘</kbd><kbd>⌥</kbd><kbd>⌃</kbd><kbd>⇧</kbd> turns into right click, middle click, backward, forward.
129+
* <kbd>↩</kbd> Return maps to left **click**. Additional <kbd>⌘</kbd><kbd>⌥</kbd><kbd>⌃</kbd><kbd>⇧</kbd> turns into right click, middle click, backward, forward.
132130

133131
| Feature | 🖱️ | 🖱️⏬ | 🖱️⏫ | 🖲️ | 🖲️⏬ | 🖲️⏫ |
134132
| :---------: | :----------: | :-------: | :-------: | :--------: | :-------: | :-------: |
@@ -194,7 +192,7 @@ Hold **<kbd>✱</kbd> Hyper** to enable hyper functionalities. We will assume a
194192
<summary>app shortcuts</summary>
195193

196194
* <kbd>E</kbd> <kbd>R</kbd> <kbd>T</kbd> <kbd>Y</kbd> <kbd>F</kbd> <kbd>G</kbd> are used as application shortcuts. (yellow area)
197-
* Popular apps and dev tools are registed to 3 default planes: <kbd>✱</kbd>/<kbd>⌘</kbd>/<kbd>⌥</kbd>. Assign these shortcuts according to your own needs.
195+
* Popular apps and dev tools are registered to 3 default planes: <kbd>✱</kbd>/<kbd>⌘</kbd>/<kbd>⌥</kbd>. Assign these shortcuts according to your own needs.
198196

199197
| Key\Mod | <kbd>✱</kbd> | <kbd>⌘</kbd> | <kbd>⌥</kbd> |
200198
| :-----: | :----------------: | :-------: | :---------: |
@@ -212,7 +210,7 @@ Hold **<kbd>✱</kbd> Hyper** to enable hyper functionalities. We will assume a
212210
<details>
213211
<summary>terminal control</summary>
214212

215-
<kbd>D</kbd>, <kbd>Z</kbd>, <kbd>X</kbd>, <kbd>C</kbd>, <kbd>V</kbd>, <kbd>B</kbd> are used as terminal control keys. Sending singals and IDE commands. (green area)
213+
<kbd>D</kbd>, <kbd>Z</kbd>, <kbd>X</kbd>, <kbd>C</kbd>, <kbd>V</kbd>, <kbd>B</kbd> are used as terminal control keys. Sending singles and IDE commands. (green area)
216214

217215
| Key\Mod | <kbd>✱</kbd> | <kbd>⌘</kbd> |
218216
| :-----: | :------------------------------------------------: | :------------------: |
@@ -363,12 +361,12 @@ Capslock serves via [**Karabiner-Elements**](https://karabiner-elements.pqrs.or
363361
# Capslock Official Site (v3)
364362
karabiner://karabiner/assets/complex_modifications/import?url=https://vonng.com/capslock.json
365363

366-
# Karabiner-Elements Offical Script Gallery (v3)
364+
# Karabiner-Elements Official Script Gallery (v3)
367365
karabiner://karabiner/assets/complex_modifications/import?url=https://pqrs.org/osx/karabiner/complex_modifications/json/caps_lock_enhancement.json
368366
```
369367
3. Launch Karabiner-Elements. **Tab: ComplexModification****Button: Add Rules**, then enabled rulesets.
370368

371-
![](mac_v3/images/config-karabiner.png)
369+
![](mac_v3/docs/img/config-karabiner.png)
372370

373371
</details>
374372

@@ -396,7 +394,7 @@ Capslock serves via [**AutoHotKey**](https://www.autohotkey.com/) on Windows.
396394

397395
#### Q: What's new in V3?
398396

399-
**A**: The original v2 only use 1 ~ 3 control planes. While v3 uses up to 9 control planes. A large number of functions have been added to make the additional modifier <kbd>⌘</kbd><kbd>⌥</kbd><kbd>⌃</kbd><kbd>⇧</kbd> functioning in a reasonable way.
397+
**A**: The original v2 only use 1 ~ 3 control planes. While v3 uses up to 9 control planes. Numerous functions have been added to make the additional modifier <kbd>⌘</kbd><kbd>⌥</kbd><kbd>⌃</kbd><kbd>⇧</kbd> functioning reasonably.
400398

401399
#### Q: Is there any incompatible changes in V3 compare to V2 ?
402400

@@ -417,15 +415,15 @@ Capslock serves via [**AutoHotKey**](https://www.autohotkey.com/) on Windows.
417415

418416
#### Q: Why is there an older version in MacOS?
419417

420-
**A**: There was an older version of Karabiner that used XML config. Apple modified it's kernel architecture in MacOS Sierra (10.12) and many programs had to be overhauled. So then there was a new version of Karabiner, the Karabiner-Elements, which is still in use today.
418+
**A**: There was an older version of Karabiner that used XML config. Apple modified its kernel architecture in MacOS Sierra (10.12) and many programs had to be overhauled. So then there was a new version of Karabiner, the Karabiner-Elements, which is still in use today.
421419

422420
#### Q: How can I customize it to my needs?
423421

424422
**A**: Just change the configuration file. Don't forget click the 'star' 🤩.
425423

426424
#### Q: Is this original?
427425

428-
**A**: I'm the first one to make a capslock overhaul schema as far as I know. The original win AHK version was wrote in 2013. The first mac version was wrote in 2015. It is the first capslock emulation schema in karabiner's [gallary](https://ke-complex-modifications.pqrs.org/#emulation-modes).
426+
**A**: I'm the first one to make a capslock overhaul schema as far as I know. The original win AHK version was wrote in 2013. The first mac version was wrote in 2015. It is the first capslock emulation schema in karabiner's [gallery](https://ke-complex-modifications.pqrs.org/#emulation-modes).
429427

430428
</details>
431429

README_ZH.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
*让Capslock再次伟大!* [![Visits Badge](https://badges.pufler.dev/visits/Vonng/Capslock)](https://badges.pufler.dev)
44

5-
![](images/logo.svg)
5+
![](docs/img/logo.svg)
66

77
将 ⇪CapsLock(大写锁定键)改造为一个强力的**功能修饰键(✱ Hyper )**,奇迹般地提高操作效率与生产力。
88

@@ -63,7 +63,7 @@
6363

6464
Capslock以**ANSI**布局键盘为蓝本,对Capslock之外的 [**所有按键**](#符号) 进行了功能定制与修饰,主要分为10大类功能。
6565

66-
![](mac_v3/images/keyboard.png)
66+
![](mac_v3/docs/img/keyboard.png)
6767

6868
> [**控制平面**](控制平面) 由左侧修饰键的排列组合所定义:根据 ⌘⌥⌃⇧的状态,最多有16个额外的控制平面。上图为0号控制平面布局。
6969
@@ -316,7 +316,7 @@ Capslock以**ANSI**布局键盘为蓝本,对Capslock之外的 [**所有按键*
316316

317317
3. 打开Karabiner-Elements,切至第三标签页`ComplexModification`,点击左下方按钮 `Add Rules`按需启用Capslock预置规则即可。
318318

319-
![](mac_v3/images/config-karabiner.png)
319+
![](mac_v3/docs/img/config-karabiner.png)
320320

321321

322322
### Windows安装
@@ -384,7 +384,7 @@ V3在整体上采用前向兼容策略,但确实有三个地方进行了不兼
384384

385385
大部分能搜索到的Capslock方案,特别是基于Karabiner与AutoHotKey的改造基本都能看到这里的影子。
386386

387-
这个配置也是Karabiner官方[Gallary](https://ke-complex-modifications.pqrs.org/#emulation-modes)收录的第一个Capslock全面改造方案,
387+
这个配置也是Karabiner官方[Gallery](https://ke-complex-modifications.pqrs.org/#emulation-modes)收录的第一个Capslock全面改造方案,
388388

389389
最近我倒是发现一些Fork不讲武德,卖钱也不署名来源,所以开源协议从WTFPL修改为Apache License 2.0。卖钱虽好,但还是要尊重一下原作者,至少保留个署名吧?
390390

File renamed without changes.
File renamed without changes.

images/logo.png docs/img/logo.png

File renamed without changes.

images/logo.svg docs/img/logo.svg

File renamed without changes.

images/trump.jpg

-69.7 KB
Binary file not shown.

0 commit comments

Comments
 (0)