diff options
| author | Ryan <fauxpark@gmail.com> | 2024-06-02 12:42:24 +1000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-06-02 12:42:24 +1000 |
| commit | 78a0adfbb4d2c4e12f93f2a62ded0020d406243e (patch) | |
| tree | e6e123b36569559233025add654580e090dc0154 /docs/reference_info_json.md | |
| parent | fa6d23235bf429446250cd5212e209d5fbfdbac2 (diff) | |
[docs] Organize driver & feature docs into subfolders (#23848)
Co-authored-by: Nick Brassel <nick@tzarc.org>
Diffstat (limited to 'docs/reference_info_json.md')
| -rw-r--r-- | docs/reference_info_json.md | 44 |
1 files changed, 22 insertions, 22 deletions
diff --git a/docs/reference_info_json.md b/docs/reference_info_json.md index 25d2e9d1d8..2db2cd1427 100644 --- a/docs/reference_info_json.md +++ b/docs/reference_info_json.md | |||
| @@ -95,7 +95,7 @@ You can create `info.json` files at every level under `qmk_firmware/keyboards/<k | |||
| 95 | 95 | ||
| 96 | ## APA102 {#apa102} | 96 | ## APA102 {#apa102} |
| 97 | 97 | ||
| 98 | Configures the [APA102](apa102_driver) driver. | 98 | Configures the [APA102](drivers/apa102) driver. |
| 99 | 99 | ||
| 100 | * `apa102` | 100 | * `apa102` |
| 101 | * `clock_pin` (Required) | 101 | * `clock_pin` (Required) |
| @@ -108,7 +108,7 @@ Configures the [APA102](apa102_driver) driver. | |||
| 108 | 108 | ||
| 109 | ## Audio {#audio} | 109 | ## Audio {#audio} |
| 110 | 110 | ||
| 111 | Configures the [Audio](feature_audio) feature. | 111 | Configures the [Audio](features/audio) feature. |
| 112 | 112 | ||
| 113 | * `audio` | 113 | * `audio` |
| 114 | * `default` | 114 | * `default` |
| @@ -138,7 +138,7 @@ Configures the [Audio](feature_audio) feature. | |||
| 138 | 138 | ||
| 139 | ## Backlight {#backlight} | 139 | ## Backlight {#backlight} |
| 140 | 140 | ||
| 141 | Configures the [Backlight](feature_backlight) feature. | 141 | Configures the [Backlight](features/backlight) feature. |
| 142 | 142 | ||
| 143 | * `backlight` | 143 | * `backlight` |
| 144 | * `as_caps_lock` | 144 | * `as_caps_lock` |
| @@ -179,7 +179,7 @@ Configures the [Backlight](feature_backlight) feature. | |||
| 179 | 179 | ||
| 180 | ## Bluetooth {#bluetooth} | 180 | ## Bluetooth {#bluetooth} |
| 181 | 181 | ||
| 182 | Configures the [Bluetooth](feature_bluetooth) feature. | 182 | Configures the [Bluetooth](features/bluetooth) feature. |
| 183 | 183 | ||
| 184 | * `bluetooth` | 184 | * `bluetooth` |
| 185 | * `driver` | 185 | * `driver` |
| @@ -187,7 +187,7 @@ Configures the [Bluetooth](feature_bluetooth) feature. | |||
| 187 | 187 | ||
| 188 | ## Bootmagic {#bootmagic} | 188 | ## Bootmagic {#bootmagic} |
| 189 | 189 | ||
| 190 | Configures the [Bootmagic](feature_bootmagic) feature. | 190 | Configures the [Bootmagic](features/bootmagic) feature. |
| 191 | 191 | ||
| 192 | * `bootmagic` | 192 | * `bootmagic` |
| 193 | * `enabled` | 193 | * `enabled` |
| @@ -199,7 +199,7 @@ Configures the [Bootmagic](feature_bootmagic) feature. | |||
| 199 | 199 | ||
| 200 | ## Caps Word {#caps-word} | 200 | ## Caps Word {#caps-word} |
| 201 | 201 | ||
| 202 | Configures the [Caps Word](feature_caps_word) feature. | 202 | Configures the [Caps Word](features/caps_word) feature. |
| 203 | 203 | ||
| 204 | * `caps_word` | 204 | * `caps_word` |
| 205 | * `both_shifts_turns_on` | 205 | * `both_shifts_turns_on` |
| @@ -220,7 +220,7 @@ Configures the [Caps Word](feature_caps_word) feature. | |||
| 220 | 220 | ||
| 221 | ## Combo {#combo} | 221 | ## Combo {#combo} |
| 222 | 222 | ||
| 223 | Configures the [Combo](feature_combo) feature. | 223 | Configures the [Combo](features/combo) feature. |
| 224 | 224 | ||
| 225 | * `combo` | 225 | * `combo` |
| 226 | * `term` | 226 | * `term` |
| @@ -229,7 +229,7 @@ Configures the [Combo](feature_combo) feature. | |||
| 229 | 229 | ||
| 230 | ## DIP Switches {#dip-switch} | 230 | ## DIP Switches {#dip-switch} |
| 231 | 231 | ||
| 232 | Configures the [DIP Switches](feature_dip_switch) feature. | 232 | Configures the [DIP Switches](features/dip_switch) feature. |
| 233 | 233 | ||
| 234 | * `dip_switch` | 234 | * `dip_switch` |
| 235 | * `enabled` | 235 | * `enabled` |
| @@ -243,7 +243,7 @@ Configures the [DIP Switches](feature_dip_switch) feature. | |||
| 243 | 243 | ||
| 244 | ## EEPROM {#eeprom} | 244 | ## EEPROM {#eeprom} |
| 245 | 245 | ||
| 246 | Configures the [EEPROM](eeprom_driver) driver. | 246 | Configures the [EEPROM](drivers/eeprom) driver. |
| 247 | 247 | ||
| 248 | * `eeprom` | 248 | * `eeprom` |
| 249 | * `driver` | 249 | * `driver` |
| @@ -259,7 +259,7 @@ Configures the [EEPROM](eeprom_driver) driver. | |||
| 259 | 259 | ||
| 260 | ## Encoder {#encoder} | 260 | ## Encoder {#encoder} |
| 261 | 261 | ||
| 262 | Configures the [Encoder](feature_encoders) feature. | 262 | Configures the [Encoder](features/encoders) feature. |
| 263 | 263 | ||
| 264 | * `encoder` | 264 | * `encoder` |
| 265 | * `rotary` | 265 | * `rotary` |
| @@ -274,7 +274,7 @@ Configures the [Encoder](feature_encoders) feature. | |||
| 274 | 274 | ||
| 275 | ## Indicators {#indicators} | 275 | ## Indicators {#indicators} |
| 276 | 276 | ||
| 277 | Configures the [LED Indicators](feature_led_indicators) feature. | 277 | Configures the [LED Indicators](features/led_indicators) feature. |
| 278 | 278 | ||
| 279 | * `indicators` | 279 | * `indicators` |
| 280 | * `caps_lock` | 280 | * `caps_lock` |
| @@ -346,7 +346,7 @@ The ISO enter key is represented by a 1.25u×2uh key. Renderers which utilize in | |||
| 346 | 346 | ||
| 347 | ## Leader Key {#leader-key} | 347 | ## Leader Key {#leader-key} |
| 348 | 348 | ||
| 349 | Configures the [Leader Key](feature_leader_key) feature. | 349 | Configures the [Leader Key](features/leader_key) feature. |
| 350 | 350 | ||
| 351 | * `leader_key` | 351 | * `leader_key` |
| 352 | * `timing` | 352 | * `timing` |
| @@ -361,7 +361,7 @@ Configures the [Leader Key](feature_leader_key) feature. | |||
| 361 | 361 | ||
| 362 | ## LED Matrix {#led-matrix} | 362 | ## LED Matrix {#led-matrix} |
| 363 | 363 | ||
| 364 | Configures the [LED Matrix](feature_led_matrix) feature. | 364 | Configures the [LED Matrix](features/led_matrix) feature. |
| 365 | 365 | ||
| 366 | * `led_matrix` | 366 | * `led_matrix` |
| 367 | * `animations` | 367 | * `animations` |
| @@ -474,7 +474,7 @@ Configures the [LED Matrix](feature_led_matrix) feature. | |||
| 474 | 474 | ||
| 475 | ## Mouse Keys {#mouse-keys} | 475 | ## Mouse Keys {#mouse-keys} |
| 476 | 476 | ||
| 477 | Configures the [Mouse Keys](feature_mouse_keys) feature. | 477 | Configures the [Mouse Keys](features/mouse_keys) feature. |
| 478 | 478 | ||
| 479 | * `mouse_key` | 479 | * `mouse_key` |
| 480 | * `delay` | 480 | * `delay` |
| @@ -498,7 +498,7 @@ Configures [One Shot keys](one_shot_keys). | |||
| 498 | 498 | ||
| 499 | ## PS/2 {#ps2} | 499 | ## PS/2 {#ps2} |
| 500 | 500 | ||
| 501 | Configures the [PS/2](feature_ps2_mouse) feature. | 501 | Configures the [PS/2](features/ps2_mouse) feature. |
| 502 | 502 | ||
| 503 | * `ps2` | 503 | * `ps2` |
| 504 | * `clock_pin` | 504 | * `clock_pin` |
| @@ -529,7 +529,7 @@ Configures the [PS/2](feature_ps2_mouse) feature. | |||
| 529 | 529 | ||
| 530 | ## RGBLight {#rgblight} | 530 | ## RGBLight {#rgblight} |
| 531 | 531 | ||
| 532 | Configures the [RGB Lighting](feature_rgblight) feature. | 532 | Configures the [RGB Lighting](features/rgblight) feature. |
| 533 | 533 | ||
| 534 | * `rgblight` | 534 | * `rgblight` |
| 535 | * `led_count` (Required) | 535 | * `led_count` (Required) |
| @@ -603,7 +603,7 @@ Configures the [RGB Lighting](feature_rgblight) feature. | |||
| 603 | 603 | ||
| 604 | ## RGB Matrix {#rgb-matrix} | 604 | ## RGB Matrix {#rgb-matrix} |
| 605 | 605 | ||
| 606 | Configures the [RGB Matrix](feature_rgb_matrix) feature. | 606 | Configures the [RGB Matrix](features/rgb_matrix) feature. |
| 607 | 607 | ||
| 608 | * `rgb_matrix` | 608 | * `rgb_matrix` |
| 609 | * `animations` | 609 | * `animations` |
| @@ -688,7 +688,7 @@ Configures the [RGB Matrix](feature_rgb_matrix) feature. | |||
| 688 | 688 | ||
| 689 | ## Secure {#secure} | 689 | ## Secure {#secure} |
| 690 | 690 | ||
| 691 | Configures the [Secure](feature_secure) feature. | 691 | Configures the [Secure](features/secure) feature. |
| 692 | 692 | ||
| 693 | * `secure` | 693 | * `secure` |
| 694 | * `enabled` | 694 | * `enabled` |
| @@ -706,7 +706,7 @@ Configures the [Secure](feature_secure) feature. | |||
| 706 | 706 | ||
| 707 | ## Split Keyboard {#split-keyboard} | 707 | ## Split Keyboard {#split-keyboard} |
| 708 | 708 | ||
| 709 | Configures the [Split Keyboard](feature_split_keyboard) feature. | 709 | Configures the [Split Keyboard](features/split_keyboard) feature. |
| 710 | 710 | ||
| 711 | * `split` | 711 | * `split` |
| 712 | * `bootmagic` | 712 | * `bootmagic` |
| @@ -745,7 +745,7 @@ Configures the [Split Keyboard](feature_split_keyboard) feature. | |||
| 745 | * Mirror the activity timestamps to the secondary half. | 745 | * Mirror the activity timestamps to the secondary half. |
| 746 | * Default: `false` | 746 | * Default: `false` |
| 747 | * `detected_os` | 747 | * `detected_os` |
| 748 | * Mirror the [detected OS](feature_os_detection) to the secondary half. | 748 | * Mirror the [detected OS](features/os_detection) to the secondary half. |
| 749 | * Default: `false` | 749 | * Default: `false` |
| 750 | * `haptic` | 750 | * `haptic` |
| 751 | * Mirror the haptic state and process haptic feedback to the secondary half. | 751 | * Mirror the haptic state and process haptic feedback to the secondary half. |
| @@ -788,7 +788,7 @@ Configures the [Split Keyboard](feature_split_keyboard) feature. | |||
| 788 | 788 | ||
| 789 | ## Stenography {#stenography} | 789 | ## Stenography {#stenography} |
| 790 | 790 | ||
| 791 | Configures the [Stenography](feature_stenography) feature. | 791 | Configures the [Stenography](features/stenography) feature. |
| 792 | 792 | ||
| 793 | * `stenography` | 793 | * `stenography` |
| 794 | * `enabled` | 794 | * `enabled` |
| @@ -838,7 +838,7 @@ Configures the [Stenography](feature_stenography) feature. | |||
| 838 | 838 | ||
| 839 | ## WS2812 {#ws2812} | 839 | ## WS2812 {#ws2812} |
| 840 | 840 | ||
| 841 | Configures the [WS2812](ws2812_driver) driver. | 841 | Configures the [WS2812](drivers/ws2812) driver. |
| 842 | 842 | ||
| 843 | * `ws2812` | 843 | * `ws2812` |
| 844 | * `driver` | 844 | * `driver` |
