diff options
| author | fauxpark <fauxpark@gmail.com> | 2018-08-01 10:40:55 +1000 |
|---|---|---|
| committer | Drashna Jaelre <drashna@live.com> | 2018-07-31 17:40:55 -0700 |
| commit | 2bc34b09cd71fc79269243712f3b6bf341169494 (patch) | |
| tree | 325f5c25336471e734dd021c268c690f93bcef93 /docs | |
| parent | 9b7a3a0bc854ac4ed38930a66be508d175f02f9d (diff) | |
| download | qmk_firmware-2bc34b09cd71fc79269243712f3b6bf341169494.tar.gz qmk_firmware-2bc34b09cd71fc79269243712f3b6bf341169494.zip | |
Docs: Format Grave Escape documentation (#3536)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/feature_grave_esc.md | 23 |
1 files changed, 15 insertions, 8 deletions
diff --git a/docs/feature_grave_esc.md b/docs/feature_grave_esc.md index a8e45f3a9a..c6fa160221 100644 --- a/docs/feature_grave_esc.md +++ b/docs/feature_grave_esc.md @@ -1,17 +1,24 @@ # Grave Escape -Grave Escape is a feature that allows you to share the grave key (<code>`</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`. +If you're using a 60% keyboard, or any other layout with no F-row, you will have noticed that there is no dedicated Escape key. Grave Escape is a feature that allows you to share the grave key (<code>`</code> and `~`) with Escape. +## Usage + +Replace the `KC_GRAVE` key in your keymap (usually to the left of the `1` key) with `KC_GESC`. When pressed it will behave like `KC_ESC`, but with Shift or GUI held it will send `KC_GRAVE`. + +## Keycodes |Key |Aliases |Description | |---------|-----------|------------------------------------------------------------------| |`KC_GESC`|`GRAVE_ESC`|Escape when pressed, <code>`</code> when Shift or GUI are held| -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: +## Configuration + +There are several possible key combinations this will break, among them Control+Shift+Escape on Windows and Command+Option+Escape on macOS. To work around this, you can `#define` these options in your `config.h`: -| Option | Description | -|--------|-------------| -| `GRAVE_ESC_ALT_OVERRIDE` | Always send Escape if Alt is pressed. | -| `GRAVE_ESC_CTRL_OVERRIDE` | Always send Escape if Ctrl is pressed. | -| `GRAVE_ESC_GUI_OVERRIDE` | Always send Escape if GUI is pressed. | -| `GRAVE_ESC_SHIFT_OVERRIDE` | Always send Escape if SHIFT is pressed. | +|Define |Description | +|--------------------------|-----------------------------------------| +|`GRAVE_ESC_ALT_OVERRIDE` |Always send Escape if Alt is pressed | +|`GRAVE_ESC_CTRL_OVERRIDE` |Always send Escape if Control is pressed | +|`GRAVE_ESC_GUI_OVERRIDE` |Always send Escape if GUI is pressed | +|`GRAVE_ESC_SHIFT_OVERRIDE`|Always send Escape if Shift is pressed | |