Skip to content

Commit c622104

Browse files
committed
Formatting cleanup
1 parent 727e921 commit c622104

File tree

1 file changed

+26
-32
lines changed

1 file changed

+26
-32
lines changed

docs/keycodes.md

Lines changed: 26 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,58 @@
1-
2-
3-
Name | Description
4-
--------------|--------------------
5-
`NO` | Do nothing
6-
`TRANSPARENT` | Use the key of next active layer
1+
| Name | Description |
2+
| ------------- | -------------------------------- |
3+
| `NO` | Do nothing |
4+
| `TRANSPARENT` | Use the key of next active layer |
75

86
## Bluetooth
97

10-
Name | Description
11-
--------------|-------------------
12-
`BT0` ~ `BT9` | Switch to Bluetooth ID n (0 - 9)
13-
`BT_TOGGLE` | Toggle Bluetooth
8+
| Name | Description |
9+
| ------------- | -------------------------------- |
10+
| `BT0` ~ `BT9` | Switch to Bluetooth ID n (0 - 9) |
11+
| `BT_TOGGLE` | Toggle Bluetooth |
1412

1513
## USB
1614

17-
Name | Description
18-
--------------|-------------------
19-
`USB_TOGGLE` | Toggle USB
15+
| Name | Description |
16+
| ------------ | ----------- |
17+
| `USB_TOGGLE` | Toggle USB |
2018

21-
!!! note
22-
When connecting the keyboard to a computer via USB, USB will be enabled automatically.
23-
When both USB and Bluetooth are enabled, USB will be used.
19+
**Note: When connecting the keyboard to a computer via USB, USB will be enabled automatically. When both USB and Bluetooth are enabled, USB will be used.**
2420

2521
## System
2622

27-
Name | Description
28-
--------------|-----------------------------------------
29-
`BOOTLOADER` | Enter the bootloader of the keyboard
30-
`HEATMAP` | Generate heatmap (todo)
31-
`SUSPEND` | Suspend. To wake up keyboard, just press any key
32-
`SHUTDOWN` | Shutdown. Use ON/OFF button to power on the keyboard
23+
| Name | Description |
24+
| ------------ | ---------------------------------------------------- |
25+
| `BOOTLOADER` | Enter the bootloader of the keyboard |
26+
| `HEATMAP` | Generate heatmap (todo) |
27+
| `SUSPEND` | Suspend. To wake up keyboard, just press any key |
28+
| `SHUTDOWN` | Shutdown. Use ON/OFF button to power on the keyboard |
3329

3430
## Layer & Modifier
3531

36-
+ `MODS_KEY(mods, key)` sends one or more modifier(s) + a normal key. `MODS()` is used to wrap modifiers.
32+
- `MODS_KEY(mods, key)` sends one or more modifier(s) + a normal key. `MODS()` is used to wrap modifiers.
3733

3834
`MODS_KEY(MODS(LCTRL), C)`, `MODS_KEY(MODS(LCTRL, LSHIFT), C)`, `MODS_KEY(MODS(LCTRL, LSHIFT, LALT), C)`
3935

40-
+ `LAYER_TOGGLE(n)` toggles layer `n`
36+
- `LAYER_TOGGLE(n)` toggles layer `n`
4137

42-
+ `MACRO(n)` creates macro `n`
38+
- `MACRO(n)` creates macro `n`
4339

4440
### TAP-Key
4541

46-
`TAP-Key` has 2 modes - tap (press and release quickly) and hold (long press)
42+
A `TAP-Key` has 2 modes - tap (press and release quickly) and hold (long press)
4743

48-
+ `LAYER_TAP(n, key)` tap - outputs `key`, hold - turns on layer n momentary
44+
- `LAYER_TAP(n, key)` tap - outputs `key`, hold - turns on layer n momentary
4945

50-
+ `LAYER_TAP_TOGGLE(n)` tap - toggles layer n, hold - turns on layer n momentary
46+
- `LAYER_TAP_TOGGLE(n)` tap - toggles layer n, hold - turns on layer n momentary
5147

52-
+ `LAYER_MODS(n, mods)` tap - outputs specified modifier(s), hold - turns on layer n momentary
48+
- `LAYER_MODS(n, mods)` tap - outputs specified modifier(s), hold - turns on layer n momentary
5349

5450
`LAYER_MODS(1, MODS(LCTRL))`, `LAYER_MODS(1, MODS(LCTRL, LSHIFT))`
5551

56-
+ `MODS_TAP(mods, key)` tap - outputs `key`, hold - outputs specified modifier(s)
52+
- `MODS_TAP(mods, key)` tap - outputs `key`, hold - outputs specified modifier(s)
5753

5854
`MODS_TAP(MODS(LCTRL), ';')`, `MODS_TAP(MODS(LCTRL, LALT), LEFT)`
5955

60-
6156
## APP & Media
6257

6358
```
@@ -298,4 +293,3 @@ SHIFT
298293
ALT
299294
GUI
300295
```
301-

0 commit comments

Comments
 (0)