Skip to content

Commit 4c675a8

Browse files
fauxparkjackhumbert
fauxpark
authored and
jackhumbert
committed
Format keycode tables
1 parent 7b0356d commit 4c675a8

12 files changed

+736
-621
lines changed

‎docs/feature_advanced_keycodes.md

+23-23
Original file line numberDiff line numberDiff line change
@@ -75,29 +75,29 @@ You can also chain these, like this:
7575
7676
The following shortcuts automatically add `LSFT()` to keycodes to get commonly used symbols.
7777
78-
|Name|Description|
79-
|----|-----------|
80-
| KC_TILD | ~ |
81-
| KC_EXLM | ! |
82-
| KC_QUES | ? |
83-
| KC_AT | @ |
84-
| KC_HASH | # |
85-
| KC_DLR | $ |
86-
| KC_PERC | % |
87-
| KC_CIRC | ^ |
88-
| KC_AMPR | & |
89-
| KC_ASTR | * |
90-
| KC_LPRN | ( |
91-
| KC_RPRN | ) |
92-
| KC_UNDS | _ |
93-
| KC_PLUS | + |
94-
| KC_DQUO | " |
95-
| KC_LCBR | { |
96-
| KC_RCBR | } |
97-
| KC_LABK | < |
98-
| KC_RABK | > |
99-
| KC_PIPE | &#x7C; |
100-
| KC_COLN | : |
78+
|Key |Aliases |Description |
79+
|------------------------|------------------|-------------------|
80+
|`KC_TILDE` |`KC_TILD` |`~` |
81+
|`KC_EXCLAIM` |`KC_EXLM` |`!` |
82+
|`KC_AT` | |`@` |
83+
|`KC_HASH` | |`#` |
84+
|`KC_DOLLAR` |`KC_DLR` |`$` |
85+
|`KC_PERCENT` |`KC_PERC` |`%` |
86+
|`KC_CIRCUMFLEX` |`KC_CIRC` |`^` |
87+
|`KC_AMPERSAND` |`KC_AMPR` |`&` |
88+
|`KC_ASTERISK` |`KC_ASTR` |`*` |
89+
|`KC_LEFT_PAREN` |`KC_LPRN` |`(` |
90+
|`KC_RIGHT_PAREN` |`KC_RPRN` |`)` |
91+
|`KC_UNDERSCORE` |`KC_UNDS` |`_` |
92+
|`KC_PLUS` | |`+` |
93+
|`KC_LEFT_CURLY_BRACE` |`KC_LCBR` |`{` |
94+
|`KC_RIGHT_CURLY_BRACE` |`KC_RCBR` |`}` |
95+
|`KC_PIPE` | |<code>&#124;</code>|
96+
|`KC_COLON` |`KC_COLN` |`:` |
97+
|`KC_DOUBLE_QUOTE` |`KC_DQT`/`KC_DQUO`|`"` |
98+
|`KC_LEFT_ANGLE_BRACKET` |`KC_LT`/`KC_LABK` |`<` |
99+
|`KC_RIGHT_ANGLE_BRACKET`|`KC_GT`/`KC_RABK` |`>` |
100+
|`KC_QUESTION` |`KC_QUES` |`?` |
101101
102102
# Mod Tap
103103

‎docs/feature_backlight.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@
66

77
These keycodes control the backlight. Most keyboards use this for single color in-switch lighting.
88

9-
|Name|Description|
10-
|----|-----------|
11-
|`BL_x`|Set a specific backlight level between 0-9|
12-
|`BL_ON`|An alias for `BL_9`|
13-
|`BL_OFF`|An alias for `BL_0`|
14-
|`BL_DEC`|Turn the backlight level down by 1|
15-
|`BL_INC`|Turn the backlight level up by 1|
16-
|`BL_TOGG`|Toggle the backlight on or off|
17-
|`BL_STEP`|Step through backlight levels, wrapping around to 0 when you reach the top.|
9+
|Key |Description |
10+
|---------|------------------------------------------|
11+
|`BL_TOGG`|Turn the backlight on or off |
12+
|`BL_STEP`|Cycle through backlight levels |
13+
|`BL_x` |Set a specific backlight level between 0-9|
14+
|`BL_ON` |An alias for `BL_9` |
15+
|`BL_OFF` |An alias for `BL_0` |
16+
|`BL_INC` |Increase backlight level |
17+
|`BL_DEC` |Decrease backlight level |

‎docs/feature_bluetooth.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ This requires [some hardware changes](https://www.reddit.com/r/MechanicalKeyboar
1010

1111
This is used when multiple keyboard outputs can be selected. Currently this only allows for switching between USB and Bluetooth on keyboards that support both.
1212

13-
|Name|Description|
14-
|----|-----------|
15-
|`OUT_AUTO`|auto mode|
16-
|`OUT_USB`|usb only|
17-
|`OUT_BT`|bluetooth|
13+
|Name |Description |
14+
|----------|----------------------------------------------|
15+
|`OUT_AUTO`|Automatically switch between USB and Bluetooth|
16+
|`OUT_USB` |USB only |
17+
|`OUT_BT` |Bluetooth only |

‎docs/feature_bootmagic.md

+21-21
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,24 @@
66

77
Shortcuts for bootmagic options. You can use these even when bootmagic is off.
88

9-
|Name|Description|
10-
|----|-----------|
11-
|`MAGIC_SWAP_CONTROL_CAPSLOCK`|Swap Capslock and Left Control|
12-
|`MAGIC_CAPSLOCK_TO_CONTROL`|Treat Capslock like a Control Key|
13-
|`MAGIC_SWAP_LALT_LGUI`|Swap the left Alt and GUI keys|
14-
|`MAGIC_SWAP_RALT_RGUI`|Swap the right Alt and GUI keys|
15-
|`MAGIC_NO_GUI`|Disable the GUI key|
16-
|`MAGIC_SWAP_GRAVE_ESC`|Swap the Grave and Esc key.|
17-
|`MAGIC_SWAP_BACKSLASH_BACKSPACE`|Swap backslash and backspace|
18-
|`MAGIC_HOST_NKRO`|Force NKRO on|
19-
|`MAGIC_SWAP_ALT_GUI`/`AG_SWAP`|Swap Alt and Gui on both sides|
20-
|`MAGIC_UNSWAP_CONTROL_CAPSLOCK`|Disable the Control/Capslock swap|
21-
|`MAGIC_UNCAPSLOCK_TO_CONTROL`|Disable treating Capslock like Control |
22-
|`MAGIC_UNSWAP_LALT_LGUI`|Disable Left Alt and GUI switching|
23-
|`MAGIC_UNSWAP_RALT_RGUI`|Disable Right Alt and GUI switching|
24-
|`MAGIC_UNNO_GUI`|Enable the GUI key |
25-
|`MAGIC_UNSWAP_GRAVE_ESC`|Disable the Grave/Esc swap |
26-
|`MAGIC_UNSWAP_BACKSLASH_BACKSPACE`|Disable the backslash/backspace swap|
27-
|`MAGIC_UNHOST_NKRO`|Force NKRO off|
28-
|`MAGIC_UNSWAP_ALT_GUI`/`AG_NORM`|Disable the Alt/GUI switching|
29-
|`MAGIC_TOGGLE_NKRO`|Turn NKRO on or off|
9+
|Key |Aliases |Description |
10+
|----------------------------------|---------|------------------------------------|
11+
|`MAGIC_SWAP_CONTROL_CAPSLOCK` | |Swap Left Control and Caps Lock |
12+
|`MAGIC_CAPSLOCK_TO_CONTROL` | |Treat Caps Lock as Control |
13+
|`MAGIC_SWAP_LALT_LGUI` | |Swap Left Alt and GUI |
14+
|`MAGIC_SWAP_RALT_RGUI` | |Swap Right Alt and GUI |
15+
|`MAGIC_NO_GUI` | |Disable the GUI key |
16+
|`MAGIC_SWAP_GRAVE_ESC` | |Swap <code>&#96;</code> and Escape |
17+
|`MAGIC_SWAP_BACKSLASH_BACKSPACE` | |Swap Backslash and Backspace |
18+
|`MAGIC_HOST_NKRO` | |Force NKRO on |
19+
|`MAGIC_SWAP_ALT_GUI` |`AG_SWAP`|Swap Alt and GUI on both sides |
20+
|`MAGIC_UNSWAP_CONTROL_CAPSLOCK` | |Unswap Left Control and Caps Lock |
21+
|`MAGIC_UNCAPSLOCK_TO_CONTROL` | |Stop treating CapsLock as Control |
22+
|`MAGIC_UNSWAP_LALT_LGUI` | |Unswap Left Alt and GUI |
23+
|`MAGIC_UNSWAP_RALT_RGUI` | |Unswap Right Alt and GUI |
24+
|`MAGIC_UNNO_GUI` | |Enable the GUI key |
25+
|`MAGIC_UNSWAP_GRAVE_ESC` | |Unswap <code>&#96;</code> and Escape|
26+
|`MAGIC_UNSWAP_BACKSLASH_BACKSPACE`| |Unswap Backslash and Backspace |
27+
|`MAGIC_UNHOST_NKRO` | |Force NKRO off |
28+
|`MAGIC_UNSWAP_ALT_GUI` |`AG_NORM`|Unswap Left Alt and GUI |
29+
|`MAGIC_TOGGLE_NKRO` | |Turn NKRO on or off |

‎docs/feature_grave_esc.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
Grave Escape is a feature that allows you to share the grave key (<code>&#96;</code> and `~`) on the same key as Escape. When `KC_GESC` is used it will act as `KC_ESC`, unless Shift or GUI is pressed, in which case it will act as `KC_GRAVE`.
44

55

6-
| Key | Alias | Description |
7-
|-----|-------|-------------|
8-
| `GRAVE_ESC` | `KC_GESC` | Act as `KC_ESC` normally, or `KC_GRAVE` when GUI or Shift are held. |
6+
|Key |Aliases |Description |
7+
|---------|-----------|------------------------------------------------------------------|
8+
|`KC_GESC`|`GRAVE_ESC`|Escape when pressed, <code>&#96;</code> when Shift or GUI are held|
99

1010
There are several possible key combinations this will break, among them Ctrl+Shift+Esc on Windows and Cmd+Opt+Esc on macOS. You can use these options in your `config.h` to work around this:
1111

‎docs/feature_mouse_keys.md

+18-18
Original file line numberDiff line numberDiff line change
@@ -21,24 +21,24 @@ You can see an example here: https://github.com/qmk/qmk_firmware/blob/master/key
2121

2222
You can use these keycodes within your keymap to map button presses to mouse actions:
2323

24-
|Long Name|Short Name|Description|
25-
|---------|----------|-----------|
26-
|KC_MS_UP|KC_MS_U|Mouse Cursor Up|
27-
|KC_MS_DOWN|KC_MS_D|Mouse Cursor Down|
28-
|KC_MS_LEFT|KC_MS_L|Mouse Cursor Left|
29-
|KC_MS_RIGHT|KC_MS_R|Mouse Cursor Right|
30-
|KC_MS_BTN1|KC_BTN1|Mouse Button 1|
31-
|KC_MS_BTN2|KC_BTN2|Mouse Button 2|
32-
|KC_MS_BTN3|KC_BTN3|Mouse Button 3|
33-
|KC_MS_BTN4|KC_BTN4|Mouse Button 4|
34-
|KC_MS_BTN5|KC_BTN5|Mouse Button 5|
35-
|KC_MS_WH_UP|KC_WH_U|Mouse Wheel Up|
36-
|KC_MS_WH_DOWN|KC_WH_D|Mouse Wheel Down|
37-
|KC_MS_WH_LEFT|KC_WH_L|Mouse Wheel Left|
38-
|KC_MS_WH_RIGHT|KC_WH_R|Mouse Wheel Right|
39-
|KC_MS_ACCEL0|KC_ACL0|Set Mouse Acceleration Speed to 0|
40-
|KC_MS_ACCEL1|KC_ACL1|Set Mouse Acceleration Speed to 1|
41-
|KC_MS_ACCEL2|KC_ACL2|Set Mouse Acceleration Speed to 2|
24+
|Key |Aliases |Description |
25+
|----------------|---------|---------------------------|
26+
|`KC_MS_UP` |`KC_MS_U`|Mouse Cursor Up |
27+
|`KC_MS_DOWN` |`KC_MS_D`|Mouse Cursor Down |
28+
|`KC_MS_LEFT` |`KC_MS_L`|Mouse Cursor Left |
29+
|`KC_MS_RIGHT` |`KC_MS_R`|Mouse Cursor Right |
30+
|`KC_MS_BTN1` |`KC_BTN1`|Mouse Button 1 |
31+
|`KC_MS_BTN2` |`KC_BTN2`|Mouse Button 2 |
32+
|`KC_MS_BTN3` |`KC_BTN3`|Mouse Button 3 |
33+
|`KC_MS_BTN4` |`KC_BTN4`|Mouse Button 4 |
34+
|`KC_MS_BTN5` |`KC_BTN5`|Mouse Button 5 |
35+
|`KC_MS_WH_UP` |`KC_WH_U`|Mouse Wheel Up |
36+
|`KC_MS_WH_DOWN` |`KC_WH_D`|Mouse Wheel Down |
37+
|`KC_MS_WH_LEFT` |`KC_WH_L`|Mouse Wheel Left |
38+
|`KC_MS_WH_RIGHT`|`KC_WH_R`|Mouse Wheel Right |
39+
|`KC_MS_ACCEL0` |`KC_ACL0`|Set mouse acceleration to 0|
40+
|`KC_MS_ACCEL1` |`KC_ACL1`|Set mouse acceleration to 1|
41+
|`KC_MS_ACCEL2` |`KC_ACL2`|Set mouse acceleration to 2|
4242

4343
You can see an example in the `_ML` here: https://github.com/qmk/qmk_firmware/blob/master/keyboards/clueboard/keymaps/mouse_keys/keymap.c#L46
4444

‎docs/feature_rgblight.md

+19-19
Original file line numberDiff line numberDiff line change
@@ -98,25 +98,25 @@ rgblight_sethsv_at(h,s,v, LED); // control a single LED. 0 <= LED < RGBLED_NUM
9898
9999
These control the RGB Lighting functionality.
100100
101-
| Long Name | Short Name | Description |
102-
|-----------|------------|-------------|
103-
||`RGB_TOG`|toggle on/off|
104-
|`RGB_MODE_FORWARD`|`RGB_MOD`|cycle through modes, use reverse direction when shift is held|
105-
|`RGB_MODE_REVERSE`|`RGB_RMOD`|cycle through modes in reverse (also suppost shift to go forward)|
106-
||`RGB_HUI`|hue increase|
107-
||`RGB_HUD`|hue decrease|
108-
||`RGB_SAI`|saturation increase|
109-
||`RGB_SAD`|saturation decrease|
110-
||`RGB_VAI`|value (brightness) increase|
111-
||`RGB_VAD`|value (brightness) decrease|
112-
|`RGB_MODE_PLAIN`|`RGB_M_P `| Switch to the static no animation mode |
113-
|`RGB_MODE_BREATHE`|`RGB_M_B`| Switch to the breathing mode |
114-
|`RGB_MODE_RAINBOW`|`RGB_M_R`| Switch to the rainbow mode ||
115-
|`RGB_MODE_SWIRL`|`RGB_M_SW`| Switch to the swirl mode |
116-
|`RGB_MODE_SNAKE`|`RGB_M_SN`| Switch to the snake mode |
117-
|`RGB_MODE_KNIGHT`|`RGB_M_K`| Switch to the knight animation |
118-
|`RGB_MODE_XMAS`|`RGB_M_X`| Switch to the Christmas animation |
119-
|`RGB_MODE_GRADIENT`|`RGB_M_G`| Switch to the static gradient mode |
101+
|Key |Aliases |Description |
102+
|-------------------|----------|--------------------------------------------------------------------|
103+
|`RGB_TOG` | |Toggle RGB lighting on or off |
104+
|`RGB_MODE_FORWARD` |`RGB_MOD` |Cycle through modes, reverse direction when Shift is held |
105+
|`RGB_MODE_REVERSE` |`RGB_RMOD`|Cycle through modes in reverse, forward direction when Shift is held|
106+
|`RGB_HUI` | |Increase hue |
107+
|`RGB_HUD` | |Decrease hue |
108+
|`RGB_SAI` | |Increase saturation |
109+
|`RGB_SAD` | |Decrease saturation |
110+
|`RGB_VAI` | |Increase value (brightness) |
111+
|`RGB_VAD` | |Decrease value (brightness) |
112+
|`RGB_MODE_PLAIN` |`RGB_M_P `|Static (no animation) mode |
113+
|`RGB_MODE_BREATHE` |`RGB_M_B` |Breathing animation mode |
114+
|`RGB_MODE_RAINBOW` |`RGB_M_R` |Rainbow animation mode |
115+
|`RGB_MODE_SWIRL` |`RGB_M_SW`|Swirl animation mode |
116+
|`RGB_MODE_SNAKE` |`RGB_M_SN`|Snake animation mode |
117+
|`RGB_MODE_KNIGHT` |`RGB_M_K` |"Knight Rider" animation mode |
118+
|`RGB_MODE_XMAS` |`RGB_M_X` |Christmas animation mode |
119+
|`RGB_MODE_GRADIENT`|`RGB_M_G` |Static gradient animation mode |
120120
121121
note: for backwards compatibility, `RGB_SMOD` is an alias for `RGB_MOD`.
122122

‎docs/feature_thermal_printer.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## Thermal Printer Keycodes
66

7-
|Name|Description|
8-
|----|-----------|
9-
|`PRINT_ON`|Start printing everything the user types|
10-
|`PRINT_OFF`|Stop printing everything the user types|
7+
|Key |Description |
8+
|-----------|----------------------------------------|
9+
|`PRINT_ON` |Start printing everything the user types|
10+
|`PRINT_OFF`|Stop printing everything the user types |

0 commit comments

Comments
 (0)