gitbot/qmk_firmware
0
0
Fork 0
mirror of https://github.com/qmk/qmk_firmware.git synced 2025-07-24 18:11:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

[docs] Align more keyboard placeholders (#25510)

Browse Source
This commit is contained in:
Joel Challis 2025-07-23 13:08:48 +01:00 committed by GitHub
parent 74d64c7f43
commit 36c3f4deba
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
17 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/drivers/aw20216s.md
View File

@ -44,7 +44,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const aw20216s_led_t PROGMEM g_aw20216s_leds[AW20216S_LED_COUNT] = {

2
docs/drivers/is31fl3218.md
View File

@ -37,7 +37,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const is31fl3218_led_t PROGMEM g_is31fl3218_leds[IS31FL3218_LED_COUNT] = {

2
docs/drivers/is31fl3236.md
View File

@ -50,7 +50,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const is31fl3236_led_t PROGMEM g_is31fl3236_leds[IS31FL3236_LED_COUNT] = {

2
docs/drivers/is31fl3729.md
View File

@ -120,7 +120,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const is31fl3729_led_t PROGMEM g_is31fl3729_leds[IS31FL3729_LED_COUNT] = {

2
docs/drivers/is31fl3731.md
View File

@ -61,7 +61,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const is31fl3731_led_t PROGMEM g_is31fl3731_leds[IS31FL3731_LED_COUNT] = {

2
docs/drivers/is31fl3733.md
View File

@ -145,7 +145,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const is31fl3733_led_t PROGMEM g_is31fl3733_leds[IS31FL3733_LED_COUNT] = {

2
docs/drivers/is31fl3736.md
View File

@ -129,7 +129,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const is31fl3736_led_t PROGMEM g_is31fl3736_leds[IS31FL3736_LED_COUNT] = {

2
docs/drivers/is31fl3737.md
View File

@ -117,7 +117,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const is31fl3737_led_t PROGMEM g_is31fl3737_leds[IS31FL3737_LED_COUNT] = {

2
docs/drivers/is31fl3741.md
View File

@ -117,7 +117,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const is31fl3741_led_t PROGMEM g_is31fl3741_leds[IS31FL3741_LED_COUNT] = {

2
docs/drivers/is31fl3742a.md
View File

@ -117,7 +117,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const is31fl3742a_led_t PROGMEM g_is31fl3742a_leds[IS31FL3742A_LED_COUNT] = {

2
docs/drivers/is31fl3743a.md
View File

@ -127,7 +127,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const is31fl3743a_led_t PROGMEM g_is31fl3743a_leds[IS31FL3743A_LED_COUNT] = {

2
docs/drivers/is31fl3745.md
View File

@ -127,7 +127,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const is31fl3745_led_t PROGMEM g_is31fl3745_leds[IS31FL3745_LED_COUNT] = {

2
docs/drivers/is31fl3746a.md
View File

@ -132,7 +132,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const is31fl3746a_led_t PROGMEM g_is31fl3746a_leds[IS31FL3746A_LED_COUNT] = {

2
docs/drivers/snled27351.md
View File

@ -52,7 +52,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const snled27351_led_t PROGMEM g_snled27351_leds[SNLED27351_LED_COUNT] = {

4
docs/getting_started_introduction.md
View File

@ -19,8 +19,8 @@ Within the folder `keyboards`, its subfolder `handwired` and its vendor and manu
* `config.h`: The file that sets the default compile time options. Do not edit this file directly, instead use a keymap specific `config.h`.
* `info.json`: The file used for setting layout for QMK Configurator. See [Configurator Support](reference_configurator_support) for more information.
* `readme.md`: A brief overview of the keyboard.
* `<keyboardName>.h`: This file is where the keyboard layout is defined against the keyboard's switch matrix.
* `<keyboardName>.c`: This file is where you can find custom code for the keyboard.
* `<keyboard>.h`: This file is where the keyboard layout is defined against the keyboard's switch matrix.
* `<keyboard>.c`: This file is where you can find custom code for the keyboard.
For more information on project structure, see [QMK Keyboard Guidelines](hardware_keyboard_guidelines).

4
docs/getting_started_make_guide.md
View File

@ -1,8 +1,8 @@
# More Detailed `make` Instructions
The full syntax of the `make` command is `<keyboard_folder>:<keymap>:<target>`, where:
The full syntax of the `make` command is `<keyboard>:<keymap>:<target>`, where:
* `<keyboard_folder>` is the path of the keyboard, for example `planck`
* `<keyboard>` is the path of the keyboard, for example `planck`
* Use `all` to compile all keyboards
* Specify the path to compile a revision, for example `planck/rev4` or `planck/rev3`
* If the keyboard doesn't have any folders, it can be left out

4
docs/hardware_keyboard_guidelines.md
View File

@ -203,7 +203,7 @@ The `post_rules.mk` file can interpret `features` of a keyboard-level before `co
See `build_keyboard.mk` and `common_features.mk` for more details.
:::
### `<keyboard.c>`
### `<keyboard>.c`
This 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.
@ -214,7 +214,7 @@ The following functions are typically defined in this file:
* `bool process_record_kb(uint16_t keycode, keyrecord_t *record)`
* `bool led_update_kb(led_t led_state)`
### `<keyboard.h>`
### `<keyboard>.h`
This 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.