summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJoel Challis <git@zvecr.com>2025-07-23 13:08:48 +0100
committerGitHub <noreply@github.com>2025-07-23 13:08:48 +0100
commit36c3f4deba7e4c670736cc95db144b25156e90f1 (patch)
treed5faa6acc97cc430c0a09b1fe5e7841b40b01588 /docs
parent74d64c7f43a9a1a0f6a0a26c981f1611ac0edaa3 (diff)
[docs] Align more keyboard placeholders (#25510)
Diffstat (limited to 'docs')
-rw-r--r--docs/drivers/aw20216s.md2
-rw-r--r--docs/drivers/is31fl3218.md2
-rw-r--r--docs/drivers/is31fl3236.md2
-rw-r--r--docs/drivers/is31fl3729.md2
-rw-r--r--docs/drivers/is31fl3731.md2
-rw-r--r--docs/drivers/is31fl3733.md2
-rw-r--r--docs/drivers/is31fl3736.md2
-rw-r--r--docs/drivers/is31fl3737.md2
-rw-r--r--docs/drivers/is31fl3741.md2
-rw-r--r--docs/drivers/is31fl3742a.md2
-rw-r--r--docs/drivers/is31fl3743a.md2
-rw-r--r--docs/drivers/is31fl3745.md2
-rw-r--r--docs/drivers/is31fl3746a.md2
-rw-r--r--docs/drivers/snled27351.md2
-rw-r--r--docs/getting_started_introduction.md4
-rw-r--r--docs/getting_started_make_guide.md4
-rw-r--r--docs/hardware_keyboard_guidelines.md4
17 files changed, 20 insertions, 20 deletions
diff --git a/docs/drivers/aw20216s.md b/docs/drivers/aw20216s.md
index 042c8df129..a8c87dd0f9 100644
--- a/docs/drivers/aw20216s.md
+++ b/docs/drivers/aw20216s.md
@@ -44,7 +44,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
44 44
45## LED Mapping {#led-mapping} 45## LED Mapping {#led-mapping}
46 46
47In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`: 47In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
48 48
49```c 49```c
50const aw20216s_led_t PROGMEM g_aw20216s_leds[AW20216S_LED_COUNT] = { 50const aw20216s_led_t PROGMEM g_aw20216s_leds[AW20216S_LED_COUNT] = {
diff --git a/docs/drivers/is31fl3218.md b/docs/drivers/is31fl3218.md
index 1c98069120..ccc70c3340 100644
--- a/docs/drivers/is31fl3218.md
+++ b/docs/drivers/is31fl3218.md
@@ -37,7 +37,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
37 37
38## LED Mapping {#led-mapping} 38## LED Mapping {#led-mapping}
39 39
40In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`: 40In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
41 41
42```c 42```c
43const is31fl3218_led_t PROGMEM g_is31fl3218_leds[IS31FL3218_LED_COUNT] = { 43const is31fl3218_led_t PROGMEM g_is31fl3218_leds[IS31FL3218_LED_COUNT] = {
diff --git a/docs/drivers/is31fl3236.md b/docs/drivers/is31fl3236.md
index 98e05e4abd..83ce227203 100644
--- a/docs/drivers/is31fl3236.md
+++ b/docs/drivers/is31fl3236.md
@@ -50,7 +50,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
50 50
51## LED Mapping {#led-mapping} 51## LED Mapping {#led-mapping}
52 52
53In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`: 53In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
54 54
55```c 55```c
56const is31fl3236_led_t PROGMEM g_is31fl3236_leds[IS31FL3236_LED_COUNT] = { 56const is31fl3236_led_t PROGMEM g_is31fl3236_leds[IS31FL3236_LED_COUNT] = {
diff --git a/docs/drivers/is31fl3729.md b/docs/drivers/is31fl3729.md
index 32618d82d5..1461874707 100644
--- a/docs/drivers/is31fl3729.md
+++ b/docs/drivers/is31fl3729.md
@@ -120,7 +120,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
120 120
121## LED Mapping {#led-mapping} 121## LED Mapping {#led-mapping}
122 122
123In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`: 123In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
124 124
125```c 125```c
126const is31fl3729_led_t PROGMEM g_is31fl3729_leds[IS31FL3729_LED_COUNT] = { 126const is31fl3729_led_t PROGMEM g_is31fl3729_leds[IS31FL3729_LED_COUNT] = {
diff --git a/docs/drivers/is31fl3731.md b/docs/drivers/is31fl3731.md
index 0d928a919e..78b3d7b1ce 100644
--- a/docs/drivers/is31fl3731.md
+++ b/docs/drivers/is31fl3731.md
@@ -61,7 +61,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
61 61
62## LED Mapping {#led-mapping} 62## LED Mapping {#led-mapping}
63 63
64In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`: 64In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
65 65
66```c 66```c
67const is31fl3731_led_t PROGMEM g_is31fl3731_leds[IS31FL3731_LED_COUNT] = { 67const is31fl3731_led_t PROGMEM g_is31fl3731_leds[IS31FL3731_LED_COUNT] = {
diff --git a/docs/drivers/is31fl3733.md b/docs/drivers/is31fl3733.md
index e299f785bd..13e9148a29 100644
--- a/docs/drivers/is31fl3733.md
+++ b/docs/drivers/is31fl3733.md
@@ -145,7 +145,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
145 145
146## LED Mapping {#led-mapping} 146## LED Mapping {#led-mapping}
147 147
148In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`: 148In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
149 149
150```c 150```c
151const is31fl3733_led_t PROGMEM g_is31fl3733_leds[IS31FL3733_LED_COUNT] = { 151const is31fl3733_led_t PROGMEM g_is31fl3733_leds[IS31FL3733_LED_COUNT] = {
diff --git a/docs/drivers/is31fl3736.md b/docs/drivers/is31fl3736.md
index b679a232cd..e03275531c 100644
--- a/docs/drivers/is31fl3736.md
+++ b/docs/drivers/is31fl3736.md
@@ -129,7 +129,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
129 129
130## LED Mapping {#led-mapping} 130## LED Mapping {#led-mapping}
131 131
132In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`: 132In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
133 133
134```c 134```c
135const is31fl3736_led_t PROGMEM g_is31fl3736_leds[IS31FL3736_LED_COUNT] = { 135const is31fl3736_led_t PROGMEM g_is31fl3736_leds[IS31FL3736_LED_COUNT] = {
diff --git a/docs/drivers/is31fl3737.md b/docs/drivers/is31fl3737.md
index d23def237f..e4663aa019 100644
--- a/docs/drivers/is31fl3737.md
+++ b/docs/drivers/is31fl3737.md
@@ -117,7 +117,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
117 117
118## LED Mapping {#led-mapping} 118## LED Mapping {#led-mapping}
119 119
120In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`: 120In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
121 121
122```c 122```c
123const is31fl3737_led_t PROGMEM g_is31fl3737_leds[IS31FL3737_LED_COUNT] = { 123const is31fl3737_led_t PROGMEM g_is31fl3737_leds[IS31FL3737_LED_COUNT] = {
diff --git a/docs/drivers/is31fl3741.md b/docs/drivers/is31fl3741.md
index dce5c08b21..b26262da7c 100644
--- a/docs/drivers/is31fl3741.md
+++ b/docs/drivers/is31fl3741.md
@@ -117,7 +117,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
117 117
118## LED Mapping {#led-mapping} 118## LED Mapping {#led-mapping}
119 119
120In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`: 120In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
121 121
122```c 122```c
123const is31fl3741_led_t PROGMEM g_is31fl3741_leds[IS31FL3741_LED_COUNT] = { 123const is31fl3741_led_t PROGMEM g_is31fl3741_leds[IS31FL3741_LED_COUNT] = {
diff --git a/docs/drivers/is31fl3742a.md b/docs/drivers/is31fl3742a.md
index ebe648cba4..e4f15162f6 100644
--- a/docs/drivers/is31fl3742a.md
+++ b/docs/drivers/is31fl3742a.md
@@ -117,7 +117,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
117 117
118## LED Mapping {#led-mapping} 118## LED Mapping {#led-mapping}
119 119
120In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`: 120In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
121 121
122```c 122```c
123const is31fl3742a_led_t PROGMEM g_is31fl3742a_leds[IS31FL3742A_LED_COUNT] = { 123const is31fl3742a_led_t PROGMEM g_is31fl3742a_leds[IS31FL3742A_LED_COUNT] = {
diff --git a/docs/drivers/is31fl3743a.md b/docs/drivers/is31fl3743a.md
index 9ca55c5eeb..b031edd5fb 100644
--- a/docs/drivers/is31fl3743a.md
+++ b/docs/drivers/is31fl3743a.md
@@ -127,7 +127,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
127 127
128## LED Mapping {#led-mapping} 128## LED Mapping {#led-mapping}
129 129
130In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`: 130In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
131 131
132```c 132```c
133const is31fl3743a_led_t PROGMEM g_is31fl3743a_leds[IS31FL3743A_LED_COUNT] = { 133const is31fl3743a_led_t PROGMEM g_is31fl3743a_leds[IS31FL3743A_LED_COUNT] = {
diff --git a/docs/drivers/is31fl3745.md b/docs/drivers/is31fl3745.md
index f13f029bfe..fb53dd3690 100644
--- a/docs/drivers/is31fl3745.md
+++ b/docs/drivers/is31fl3745.md
@@ -127,7 +127,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
127 127
128## LED Mapping {#led-mapping} 128## LED Mapping {#led-mapping}
129 129
130In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`: 130In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
131 131
132```c 132```c
133const is31fl3745_led_t PROGMEM g_is31fl3745_leds[IS31FL3745_LED_COUNT] = { 133const is31fl3745_led_t PROGMEM g_is31fl3745_leds[IS31FL3745_LED_COUNT] = {
diff --git a/docs/drivers/is31fl3746a.md b/docs/drivers/is31fl3746a.md
index bdd5c18357..19439a8a40 100644
--- a/docs/drivers/is31fl3746a.md
+++ b/docs/drivers/is31fl3746a.md
@@ -132,7 +132,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
132 132
133## LED Mapping {#led-mapping} 133## LED Mapping {#led-mapping}
134 134
135In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`: 135In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
136 136
137```c 137```c
138const is31fl3746a_led_t PROGMEM g_is31fl3746a_leds[IS31FL3746A_LED_COUNT] = { 138const is31fl3746a_led_t PROGMEM g_is31fl3746a_leds[IS31FL3746A_LED_COUNT] = {
diff --git a/docs/drivers/snled27351.md b/docs/drivers/snled27351.md
index 1d91182f7c..c0785711d9 100644
--- a/docs/drivers/snled27351.md
+++ b/docs/drivers/snled27351.md
@@ -52,7 +52,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
52 52
53## LED Mapping {#led-mapping} 53## LED Mapping {#led-mapping}
54 54
55In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`: 55In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
56 56
57```c 57```c
58const snled27351_led_t PROGMEM g_snled27351_leds[SNLED27351_LED_COUNT] = { 58const snled27351_led_t PROGMEM g_snled27351_leds[SNLED27351_LED_COUNT] = {
diff --git a/docs/getting_started_introduction.md b/docs/getting_started_introduction.md
index 9417351747..4a44e0e700 100644
--- a/docs/getting_started_introduction.md
+++ b/docs/getting_started_introduction.md
@@ -19,8 +19,8 @@ Within the folder `keyboards`, its subfolder `handwired` and its vendor and manu
19* `config.h`: The file that sets the default compile time options. Do not edit this file directly, instead use a keymap specific `config.h`. 19* `config.h`: The file that sets the default compile time options. Do not edit this file directly, instead use a keymap specific `config.h`.
20* `info.json`: The file used for setting layout for QMK Configurator. See [Configurator Support](reference_configurator_support) for more information. 20* `info.json`: The file used for setting layout for QMK Configurator. See [Configurator Support](reference_configurator_support) for more information.
21* `readme.md`: A brief overview of the keyboard. 21* `readme.md`: A brief overview of the keyboard.
22* `<keyboardName>.h`: This file is where the keyboard layout is defined against the keyboard's switch matrix. 22* `<keyboard>.h`: This file is where the keyboard layout is defined against the keyboard's switch matrix.
23* `<keyboardName>.c`: This file is where you can find custom code for the keyboard. 23* `<keyboard>.c`: This file is where you can find custom code for the keyboard.
24 24
25For more information on project structure, see [QMK Keyboard Guidelines](hardware_keyboard_guidelines). 25For more information on project structure, see [QMK Keyboard Guidelines](hardware_keyboard_guidelines).
26 26
diff --git a/docs/getting_started_make_guide.md b/docs/getting_started_make_guide.md
index 59455adb30..54f915e444 100644
--- a/docs/getting_started_make_guide.md
+++ b/docs/getting_started_make_guide.md
@@ -1,8 +1,8 @@
1# More Detailed `make` Instructions 1# More Detailed `make` Instructions
2 2
3The full syntax of the `make` command is `<keyboard_folder>:<keymap>:<target>`, where: 3The full syntax of the `make` command is `<keyboard>:<keymap>:<target>`, where:
4 4
5* `<keyboard_folder>` is the path of the keyboard, for example `planck` 5* `<keyboard>` is the path of the keyboard, for example `planck`
6 * Use `all` to compile all keyboards 6 * Use `all` to compile all keyboards
7 * Specify the path to compile a revision, for example `planck/rev4` or `planck/rev3` 7 * Specify the path to compile a revision, for example `planck/rev4` or `planck/rev3`
8 * If the keyboard doesn't have any folders, it can be left out 8 * If the keyboard doesn't have any folders, it can be left out
diff --git a/docs/hardware_keyboard_guidelines.md b/docs/hardware_keyboard_guidelines.md
index 4df443f9fc..0b8f35a373 100644
--- a/docs/hardware_keyboard_guidelines.md
+++ b/docs/hardware_keyboard_guidelines.md
@@ -203,7 +203,7 @@ The `post_rules.mk` file can interpret `features` of a keyboard-level before `co
203See `build_keyboard.mk` and `common_features.mk` for more details. 203See `build_keyboard.mk` and `common_features.mk` for more details.
204::: 204:::
205 205
206### `<keyboard.c>` 206### `<keyboard>.c`
207 207
208This file should contain C code required for the functionality of your keyboard, for example hardware initialisation code, OLED display code, and so on. This file should only contain code necessary for the keyboard to work, and *not* things that should be left to the end user to configure in their keymap. This file is automatically included in compilation if it exists. This is not a required file. 208This file should contain C code required for the functionality of your keyboard, for example hardware initialisation code, OLED display code, and so on. This file should only contain code necessary for the keyboard to work, and *not* things that should be left to the end user to configure in their keymap. This file is automatically included in compilation if it exists. This is not a required file.
209 209
@@ -214,7 +214,7 @@ The following functions are typically defined in this file:
214* `bool process_record_kb(uint16_t keycode, keyrecord_t *record)` 214* `bool process_record_kb(uint16_t keycode, keyrecord_t *record)`
215* `bool led_update_kb(led_t led_state)` 215* `bool led_update_kb(led_t led_state)`
216 216
217### `<keyboard.h>` 217### `<keyboard>.h`
218 218
219This file can contain function prototypes for custom functions and other header file code utilised by `<keyboard>.c`. The `<keyboard>.c` file should include this file. This is not a required file. 219This file can contain function prototypes for custom functions and other header file code utilised by `<keyboard>.c`. The `<keyboard>.c` file should include this file. This is not a required file.
220 220