aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorGravatar fauxpark <fauxpark@gmail.com>2020-02-07 15:54:14 +1100
committerGravatar GitHub <noreply@github.com>2020-02-07 15:54:14 +1100
commita73c38112dedaeeb837fb9d388f17becd8480f95 (patch)
tree5695c82eb0944ea77b4c5148917f6f4239b0e3c6 /docs
parente3444084fb11b1c53a3fc24a064f7c501214cb8b (diff)
downloadqmk_firmware-a73c38112dedaeeb837fb9d388f17becd8480f95.tar.gz
Move Grave Escape, Lock and Leader keycodes into their own sect… (#8093)
Diffstat (limited to 'docs')
-rw-r--r--docs/keycodes.md33
-rw-r--r--docs/quantum_keycodes.md13
2 files changed, 29 insertions, 17 deletions
diff --git a/docs/keycodes.md b/docs/keycodes.md
index dd4c4418b..c151c5700 100644
--- a/docs/keycodes.md
+++ b/docs/keycodes.md
@@ -208,14 +208,11 @@ This is a reference only. Each group of keys links to the page documenting their
## [Quantum Keycodes](quantum_keycodes.md#qmk-keycodes)
-|Key |Aliases |Description |
-|---------------|-----------|---------------------------------------------------------------------|
-|`RESET` | |Put the keyboard into DFU mode for flashing |
-|`DEBUG` | |Toggle debug mode |
-|`EEPROM_RESET` |`EEP_RST` |Resets EEPROM state by reinitializing it |
-|`KC_GESC` |`GRAVE_ESC`|Escape when tapped, <code>&#96;</code> when pressed with Shift or GUI|
-|`KC_LEAD` | |The [Leader key](feature_leader_key.md) |
-|`KC_LOCK` | |The [Lock key](feature_key_lock.md) |
+|Key |Aliases |Description |
+|--------------|---------|-------------------------------------------------------|
+|`RESET` | |Put the keyboard into bootloader mode for flashing |
+|`DEBUG` | |Toggle debug mode |
+|`EEPROM_RESET`|`EEP_RST`|Reinitializes the keyboard's EEPROM (persistent memory)|
## [Audio Keys](feature_audio.md)
@@ -289,7 +286,7 @@ This is a reference only. Each group of keys links to the page documenting their
## [Dynamic Macros](feature_dynamic_macros.md)
-|Key |Alias |Description |
+|Key |Aliases |Description |
|-----------------|---------|--------------------------------------------------|
|`DYN_REC_START1` |`DM_REC1`|Start recording Macro 1 |
|`DYN_REC_START2` |`DM_REC2`|Start recording Macro 2 |
@@ -297,6 +294,18 @@ This is a reference only. Each group of keys links to the page documenting their
|`DYN_MACRO_PLAY2`|`DM_PLY2`|Replay Macro 2 |
|`DYN_REC_STOP` |`DM_RSTP`|Finish the macro that is currently being recorded.|
+## [Grave Escape](feature_grave_esc.md)
+
+|Key |Aliases |Description |
+|-----------|---------|------------------------------------------------------------------|
+|`GRAVE_ESC`|`KC_GESC`|Escape when pressed, <code>&#96;</code> when Shift or GUI are held|
+
+## [Key Lock](feature_key_lock.md)
+
+|Key |Description |
+|---------|--------------------------------------------------------------|
+|`KC_LOCK`|Hold down the next key pressed, until the key is pressed again|
+
## [Layer Switching](feature_advanced_keycodes.md#switching-and-toggling-layers)
|Key |Description |
@@ -310,6 +319,12 @@ This is a reference only. Each group of keys links to the page documenting their
|`TO(layer)` |Turns on `layer` and turns off all other layers, except the default layer |
|`TT(layer)` |Normally acts like MO unless it's tapped multiple times, which toggles `layer` on |
+## [Leader Key](feature_leader_key.md)
+
+|Key |Description |
+|---------|------------------------|
+|`KC_LEAD`|Begins a leader sequence|
+
## [Mouse Keys](feature_mouse_keys.md)
|Key |Aliases |Description |
diff --git a/docs/quantum_keycodes.md b/docs/quantum_keycodes.md
index 26ce6d244..969849cda 100644
--- a/docs/quantum_keycodes.md
+++ b/docs/quantum_keycodes.md
@@ -8,11 +8,8 @@ On this page we have documented keycodes between `0x00FF` and `0xFFFF` which are
## QMK Keycodes
-|Key |Aliases |Description |
-|---------------|-----------|---------------------------------------------------------------------|
-|`RESET` | |Put the keyboard into DFU mode for flashing |
-|`DEBUG` | |Toggle debug mode |
-|`EEPROM_RESET` |`EEP_RST` |Resets EEPROM state by reinitializing it |
-|`KC_GESC` |`GRAVE_ESC`|Escape when tapped, <code>&#96;</code> when pressed with Shift or GUI|
-|`KC_LEAD` | |The [Leader key](feature_leader_key.md) |
-|`KC_LOCK` | |The [Lock key](feature_key_lock.md) |
+|Key |Aliases |Description |
+|--------------|---------|-------------------------------------------------------|
+|`RESET` | |Put the keyboard into bootloader mode for flashing |
+|`DEBUG` | |Toggle debug mode |
+|`EEPROM_RESET`|`EEP_RST`|Reinitializes the keyboard's EEPROM (persistent memory)|