diff options
author | James Young <xxiinophobia@yahoo.com> | 2020-03-05 15:23:07 -0800 |
---|---|---|
committer | skullydazed <skullydazed@users.noreply.github.com> | 2020-03-05 16:00:10 -0800 |
commit | 772bacb7703096df3684bf97732f7fdb79a5a3a7 (patch) | |
tree | 1208387bd7f17c623badeb14e3b4599bb8681acb /docs/keycodes.md | |
parent | 961477c791195ebf2d4c1f533807cb46c194d939 (diff) | |
download | qmk_firmware-772bacb7703096df3684bf97732f7fdb79a5a3a7.tar.gz qmk_firmware-772bacb7703096df3684bf97732f7fdb79a5a3a7.zip |
keycodes.md: don't use section headings as links
It prevents the Table of Contents from parsing that heading.
Diffstat (limited to 'docs/keycodes.md')
-rw-r--r-- | docs/keycodes.md | 88 |
1 files changed, 66 insertions, 22 deletions
diff --git a/docs/keycodes.md b/docs/keycodes.md index f207c523e..b70f1c44d 100644 --- a/docs/keycodes.md +++ b/docs/keycodes.md | |||
@@ -4,7 +4,9 @@ When defining a [keymap](keymap.md) each key needs a valid key definition. This | |||
4 | 4 | ||
5 | This is a reference only. Each group of keys links to the page documenting their functionality in more detail. | 5 | This is a reference only. Each group of keys links to the page documenting their functionality in more detail. |
6 | 6 | ||
7 | ## [Basic Keycodes](keycodes_basic.md) | 7 | ## Basic Keycodes |
8 | |||
9 | See also: [Basic Keycodes](keycodes_basic.md) | ||
8 | 10 | ||
9 | |Key |Aliases |Description | | 11 | |Key |Aliases |Description | |
10 | |-----------------------|------------------------------|-----------------------------------------------| | 12 | |-----------------------|------------------------------|-----------------------------------------------| |
@@ -206,7 +208,9 @@ This is a reference only. Each group of keys links to the page documenting their | |||
206 | |`KC_BRIGHTNESS_UP` |`KC_BRIU` |Brightness Up | | 208 | |`KC_BRIGHTNESS_UP` |`KC_BRIU` |Brightness Up | |
207 | |`KC_BRIGHTNESS_DOWN` |`KC_BRID` |Brightness Down | | 209 | |`KC_BRIGHTNESS_DOWN` |`KC_BRID` |Brightness Down | |
208 | 210 | ||
209 | ## [Quantum Keycodes](quantum_keycodes.md#qmk-keycodes) | 211 | ## Quantum Keycodes |
212 | |||
213 | See also: [Quantum Keycodes](quantum_keycodes.md#qmk-keycodes) | ||
210 | 214 | ||
211 | |Key |Aliases |Description | | 215 | |Key |Aliases |Description | |
212 | |--------------|---------|-------------------------------------------------------| | 216 | |--------------|---------|-------------------------------------------------------| |
@@ -214,7 +218,9 @@ This is a reference only. Each group of keys links to the page documenting their | |||
214 | |`DEBUG` | |Toggle debug mode | | 218 | |`DEBUG` | |Toggle debug mode | |
215 | |`EEPROM_RESET`|`EEP_RST`|Reinitializes the keyboard's EEPROM (persistent memory)| | 219 | |`EEPROM_RESET`|`EEP_RST`|Reinitializes the keyboard's EEPROM (persistent memory)| |
216 | 220 | ||
217 | ## [Audio Keys](feature_audio.md) | 221 | ## Audio Keys |
222 | |||
223 | See also: [Audio](feature_audio.md) | ||
218 | 224 | ||
219 | |Key |Aliases |Description | | 225 | |Key |Aliases |Description | |
220 | |----------------|---------|----------------------------------| | 226 | |----------------|---------|----------------------------------| |
@@ -230,7 +236,9 @@ This is a reference only. Each group of keys links to the page documenting their | |||
230 | |`MU_TOG` | |Toggles Music Mode | | 236 | |`MU_TOG` | |Toggles Music Mode | |
231 | |`MU_MOD` | |Cycles through the music modes | | 237 | |`MU_MOD` | |Cycles through the music modes | |
232 | 238 | ||
233 | ## [Backlighting](feature_backlight.md) | 239 | ## Backlighting |
240 | |||
241 | See also: [Backlighting](feature_backlight.md) | ||
234 | 242 | ||
235 | |Key |Description | | 243 | |Key |Description | |
236 | |---------|------------------------------------------| | 244 | |---------|------------------------------------------| |
@@ -242,7 +250,9 @@ This is a reference only. Each group of keys links to the page documenting their | |||
242 | |`BL_DEC` |Decrease the backlight level | | 250 | |`BL_DEC` |Decrease the backlight level | |
243 | |`BL_BRTG`|Toggle backlight breathing | | 251 | |`BL_BRTG`|Toggle backlight breathing | |
244 | 252 | ||
245 | ## [Bootmagic](feature_bootmagic.md) | 253 | ## Bootmagic |
254 | |||
255 | See also: [Bootmagic](feature_bootmagic.md) | ||
246 | 256 | ||
247 | |Key |Aliases |Description | | 257 | |Key |Aliases |Description | |
248 | |----------------------------------|---------|--------------------------------------------------------------------------| | 258 | |----------------------------------|---------|--------------------------------------------------------------------------| |
@@ -276,7 +286,9 @@ This is a reference only. Each group of keys links to the page documenting their | |||
276 | |`MAGIC_EE_HANDS_LEFT` |`EH_LEFT`|Set the master half of a split keyboard as the left hand (for `EE_HANDS`) | | 286 | |`MAGIC_EE_HANDS_LEFT` |`EH_LEFT`|Set the master half of a split keyboard as the left hand (for `EE_HANDS`) | |
277 | |`MAGIC_EE_HANDS_RIGHT` |`EH_RGHT`|Set the master half of a split keyboard as the right hand (for `EE_HANDS`)| | 287 | |`MAGIC_EE_HANDS_RIGHT` |`EH_RGHT`|Set the master half of a split keyboard as the right hand (for `EE_HANDS`)| |
278 | 288 | ||
279 | ## [Bluetooth](feature_bluetooth.md) | 289 | ## Bluetooth |
290 | |||
291 | See also: [Bluetooth](feature_bluetooth.md) | ||
280 | 292 | ||
281 | |Key |Description | | 293 | |Key |Description | |
282 | |----------|----------------------------------------------| | 294 | |----------|----------------------------------------------| |
@@ -284,7 +296,9 @@ This is a reference only. Each group of keys links to the page documenting their | |||
284 | |`OUT_USB` |USB only | | 296 | |`OUT_USB` |USB only | |
285 | |`OUT_BT` |Bluetooth only | | 297 | |`OUT_BT` |Bluetooth only | |
286 | 298 | ||
287 | ## [Dynamic Macros](feature_dynamic_macros.md) | 299 | ## Dynamic Macros |
300 | |||
301 | See also: [Dynamic Macros](feature_dynamic_macros.md) | ||
288 | 302 | ||
289 | |Key |Aliases |Description | | 303 | |Key |Aliases |Description | |
290 | |-----------------|---------|--------------------------------------------------| | 304 | |-----------------|---------|--------------------------------------------------| |
@@ -294,19 +308,25 @@ This is a reference only. Each group of keys links to the page documenting their | |||
294 | |`DYN_MACRO_PLAY2`|`DM_PLY2`|Replay Macro 2 | | 308 | |`DYN_MACRO_PLAY2`|`DM_PLY2`|Replay Macro 2 | |
295 | |`DYN_REC_STOP` |`DM_RSTP`|Finish the macro that is currently being recorded.| | 309 | |`DYN_REC_STOP` |`DM_RSTP`|Finish the macro that is currently being recorded.| |
296 | 310 | ||
297 | ## [Grave Escape](feature_grave_esc.md) | 311 | ## Grave Escape |
312 | |||
313 | See also: [Grave Escape](feature_grave_esc.md) | ||
298 | 314 | ||
299 | |Key |Aliases |Description | | 315 | |Key |Aliases |Description | |
300 | |-----------|---------|------------------------------------------------------------------| | 316 | |-----------|---------|------------------------------------------------------------------| |
301 | |`GRAVE_ESC`|`KC_GESC`|Escape when pressed, <code>`</code> when Shift or GUI are held| | 317 | |`GRAVE_ESC`|`KC_GESC`|Escape when pressed, <code>`</code> when Shift or GUI are held| |
302 | 318 | ||
303 | ## [Key Lock](feature_key_lock.md) | 319 | ## Key Lock |
320 | |||
321 | See also: [Key Lock](feature_key_lock.md) | ||
304 | 322 | ||
305 | |Key |Description | | 323 | |Key |Description | |
306 | |---------|--------------------------------------------------------------| | 324 | |---------|--------------------------------------------------------------| |
307 | |`KC_LOCK`|Hold down the next key pressed, until the key is pressed again| | 325 | |`KC_LOCK`|Hold down the next key pressed, until the key is pressed again| |
308 | 326 | ||
309 | ## [Layer Switching](feature_advanced_keycodes.md#switching-and-toggling-layers) | 327 | ## Layer Switching |
328 | |||
329 | See also: [Layer Switching](feature_advanced_keycodes.md#switching-and-toggling-layers) | ||
310 | 330 | ||
311 | |Key |Description | | 331 | |Key |Description | |
312 | |----------------|----------------------------------------------------------------------------------| | 332 | |----------------|----------------------------------------------------------------------------------| |
@@ -319,13 +339,17 @@ This is a reference only. Each group of keys links to the page documenting their | |||
319 | |`TO(layer)` |Turns on `layer` and turns off all other layers, except the default layer | | 339 | |`TO(layer)` |Turns on `layer` and turns off all other layers, except the default layer | |
320 | |`TT(layer)` |Normally acts like MO unless it's tapped multiple times, which toggles `layer` on | | 340 | |`TT(layer)` |Normally acts like MO unless it's tapped multiple times, which toggles `layer` on | |
321 | 341 | ||
322 | ## [Leader Key](feature_leader_key.md) | 342 | ## Leader Key |
343 | |||
344 | See also: [Leader Key](feature_leader_key.md) | ||
323 | 345 | ||
324 | |Key |Description | | 346 | |Key |Description | |
325 | |---------|------------------------| | 347 | |---------|------------------------| |
326 | |`KC_LEAD`|Begins a leader sequence| | 348 | |`KC_LEAD`|Begins a leader sequence| |
327 | 349 | ||
328 | ## [Mouse Keys](feature_mouse_keys.md) | 350 | ## Mouse Keys |
351 | |||
352 | See also: [Mouse Keys](feature_mouse_keys.md) | ||
329 | 353 | ||
330 | |Key |Aliases |Description | | 354 | |Key |Aliases |Description | |
331 | |----------------|---------|---------------------------| | 355 | |----------------|---------|---------------------------| |
@@ -346,7 +370,9 @@ This is a reference only. Each group of keys links to the page documenting their | |||
346 | |`KC_MS_ACCEL1` |`KC_ACL1`|Set mouse acceleration to 1| | 370 | |`KC_MS_ACCEL1` |`KC_ACL1`|Set mouse acceleration to 1| |
347 | |`KC_MS_ACCEL2` |`KC_ACL2`|Set mouse acceleration to 2| | 371 | |`KC_MS_ACCEL2` |`KC_ACL2`|Set mouse acceleration to 2| |
348 | 372 | ||
349 | ## [Modifiers](feature_advanced_keycodes.md#modifier-keys) | 373 | ## Modifiers |
374 | |||
375 | See also: [Modifier Keys](feature_advanced_keycodes.md#modifier-keys) | ||
350 | 376 | ||
351 | |Key |Aliases |Description | | 377 | |Key |Aliases |Description | |
352 | |----------|-------------------------------|----------------------------------------------------| | 378 | |----------|-------------------------------|----------------------------------------------------| |
@@ -366,7 +392,9 @@ This is a reference only. Each group of keys links to the page documenting their | |||
366 | |`KC_MEH` | |Left Control, Shift and Alt | | 392 | |`KC_MEH` | |Left Control, Shift and Alt | |
367 | |`KC_HYPR` | |Left Control, Shift, Alt and GUI | | 393 | |`KC_HYPR` | |Left Control, Shift, Alt and GUI | |
368 | 394 | ||
369 | ## [Mod-Tap Keys](mod_tap.md) | 395 | ## Mod-Tap Keys |
396 | |||
397 | See also: [Mod-Tap](mod_tap.md) | ||
370 | 398 | ||
371 | |Key |Aliases |Description | | 399 | |Key |Aliases |Description | |
372 | |-------------|-----------------------------------------------------------------|-------------------------------------------------------| | 400 | |-------------|-----------------------------------------------------------------|-------------------------------------------------------| |
@@ -387,7 +415,9 @@ This is a reference only. Each group of keys links to the page documenting their | |||
387 | |`MEH_T(kc)` | |Left Control, Shift and Alt when held, `kc` when tapped| | 415 | |`MEH_T(kc)` | |Left Control, Shift and Alt when held, `kc` when tapped| |
388 | |`HYPR_T(kc)` |`ALL_T(kc)` |Left Control, Shift, Alt and GUI when held, `kc` when tapped - more info [here](http://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/)| | 416 | |`HYPR_T(kc)` |`ALL_T(kc)` |Left Control, Shift, Alt and GUI when held, `kc` when tapped - more info [here](http://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/)| |
389 | 417 | ||
390 | ## [RGB Lighting](feature_rgblight.md) | 418 | ## RGB Lighting |
419 | |||
420 | See also: [RGB Lighting](feature_rgblight.md) | ||
391 | 421 | ||
392 | |Key |Aliases |Description | | 422 | |Key |Aliases |Description | |
393 | |-------------------|----------|--------------------------------------------------------------------| | 423 | |-------------------|----------|--------------------------------------------------------------------| |
@@ -410,7 +440,9 @@ This is a reference only. Each group of keys links to the page documenting their | |||
410 | |`RGB_MODE_GRADIENT`|`RGB_M_G` |Static gradient animation mode | | 440 | |`RGB_MODE_GRADIENT`|`RGB_M_G` |Static gradient animation mode | |
411 | |`RGB_MODE_RGBTEST` |`RGB_M_T` |Red,Green,Blue test animation mode | | 441 | |`RGB_MODE_RGBTEST` |`RGB_M_T` |Red,Green,Blue test animation mode | |
412 | 442 | ||
413 | ## [RGB Matrix Lighting](feature_rgb_matrix.md) | 443 | ## RGB Matrix Lighting |
444 | |||
445 | See also: [RGB Matrix Lighting](feature_rgb_matrix.md) | ||
414 | 446 | ||
415 | |Key |Aliases |Description | | 447 | |Key |Aliases |Description | |
416 | |-------------------|----------|--------------------------------------------------------------------------------------| | 448 | |-------------------|----------|--------------------------------------------------------------------------------------| |
@@ -426,14 +458,18 @@ This is a reference only. Each group of keys links to the page documenting their | |||
426 | |`RGB_SPI` | |Increase effect speed (does not support eeprom yet), decrease speed when Shift is held| | 458 | |`RGB_SPI` | |Increase effect speed (does not support eeprom yet), decrease speed when Shift is held| |
427 | |`RGB_SPD` | |Decrease effect speed (does not support eeprom yet), increase speed when Shift is held| | 459 | |`RGB_SPD` | |Decrease effect speed (does not support eeprom yet), increase speed when Shift is held| |
428 | 460 | ||
429 | ## [Thermal Printer](feature_thermal_printer.md) | 461 | ## Thermal Printer |
462 | |||
463 | See also: [Thermal Printer](feature_thermal_printer.md) | ||
430 | 464 | ||
431 | |Key |Description | | 465 | |Key |Description | |
432 | |-----------|----------------------------------------| | 466 | |-----------|----------------------------------------| |
433 | |`PRINT_ON` |Start printing everything the user types| | 467 | |`PRINT_ON` |Start printing everything the user types| |
434 | |`PRINT_OFF`|Stop printing everything the user types | | 468 | |`PRINT_OFF`|Stop printing everything the user types | |
435 | 469 | ||
436 | ## [US ANSI Shifted Symbols](keycodes_us_ansi_shifted.md) | 470 | ## US ANSI Shifted Symbols |
471 | |||
472 | See also: [US ANSI Shifted Symbols](keycodes_us_ansi_shifted.md) | ||
437 | 473 | ||
438 | |Key |Aliases |Description| | 474 | |Key |Aliases |Description| |
439 | |------------------------|-------------------|-----------| | 475 | |------------------------|-------------------|-----------| |
@@ -459,14 +495,18 @@ This is a reference only. Each group of keys links to the page documenting their | |||
459 | |`KC_RIGHT_ANGLE_BRACKET`|`KC_RABK`, `KC_GT` |`>` | | 495 | |`KC_RIGHT_ANGLE_BRACKET`|`KC_RABK`, `KC_GT` |`>` | |
460 | |`KC_QUESTION` |`KC_QUES` |`?` | | 496 | |`KC_QUESTION` |`KC_QUES` |`?` | |
461 | 497 | ||
462 | ## [One Shot Keys](one_shot_keys.md) | 498 | ## One Shot Keys |
499 | |||
500 | See also: [One Shot Keys](one_shot_keys.md) | ||
463 | 501 | ||
464 | |Key |Description | | 502 | |Key |Description | |
465 | |------------|----------------------------------| | 503 | |------------|----------------------------------| |
466 | |`OSM(mod)` |Hold `mod` for one keypress | | 504 | |`OSM(mod)` |Hold `mod` for one keypress | |
467 | |`OSL(layer)`|Switch to `layer` for one keypress| | 505 | |`OSL(layer)`|Switch to `layer` for one keypress| |
468 | 506 | ||
469 | ## [Space Cadet](feature_space_cadet.md) | 507 | ## Space Cadet |
508 | |||
509 | See also: [Space Cadet](feature_space_cadet.md) | ||
470 | 510 | ||
471 | |Key |Description | | 511 | |Key |Description | |
472 | |-----------|----------------------------------------| | 512 | |-----------|----------------------------------------| |
@@ -478,7 +518,9 @@ This is a reference only. Each group of keys links to the page documenting their | |||
478 | |`KC_RAPC` |Right Alt when held, `)` when tapped | | 518 | |`KC_RAPC` |Right Alt when held, `)` when tapped | |
479 | |`KC_SFTENT`|Right Shift when held, Enter when tapped| | 519 | |`KC_SFTENT`|Right Shift when held, Enter when tapped| |
480 | 520 | ||
481 | ## [Swap Hands](feature_swap_hands.md) | 521 | ## Swap Hands |
522 | |||
523 | See also: [Swap Hands](feature_swap_hands.md) | ||
482 | 524 | ||
483 | |Key |Description | | 525 | |Key |Description | |
484 | |-----------|-------------------------------------------------------------------------| | 526 | |-----------|-------------------------------------------------------------------------| |
@@ -490,7 +532,9 @@ This is a reference only. Each group of keys links to the page documenting their | |||
490 | |`SH_TG` |Toggles swap on and off with every key press. | | 532 | |`SH_TG` |Toggles swap on and off with every key press. | |
491 | |`SH_TT` |Toggles with a tap; momentary when held. | | 533 | |`SH_TT` |Toggles with a tap; momentary when held. | |
492 | 534 | ||
493 | ## [Unicode Support](feature_unicode.md) | 535 | ## Unicode Support |
536 | |||
537 | See also: [Unicode Support](feature_unicode.md) | ||
494 | 538 | ||
495 | |Key |Aliases |Description | | 539 | |Key |Aliases |Description | |
496 | |----------------------|---------|----------------------------------------------------------------| | 540 | |----------------------|---------|----------------------------------------------------------------| |