docs/feature_grave_esc.md

   1 # Grave Escape
   2
   3 Grave Escape is a feature that allows you to share the grave key (`\`` 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`.
   4
   5
   6 | Key | Alias | Description |
   7 |-----|-------|-------------|
   8 | `GRAVE_ESC` | `KC_GESC` | Act as `KC_ESC` normally, or `KC_GRAVE` when GUI or Shift are held. |
   9
  10 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:
  11
  12 | Option | Description |
  13 |--------|-------------|
  14 | `GRAVE_ESC_ALT_OVERRIDE` | Always send Escape if Alt is pressed. |
  15 | `GRAVE_ESC_CTRL_OVERRIDE` | Always send Escape if Ctrl is pressed. |
  16 | `GRAVE_ESC_GUI_OVERRIDE` | Always send Escape if GUI is pressed. |
  17 | `GRAVE_ESC_SHIFT_OVERRIDE` | Always send Escape if SHIFT is pressed. |