keyboard stuff
0
fork

Configure Feed

Select the types of activity you want to include in your feed.

[docs] Align more keyboard placeholders (#25510)

authored by

Joel Challis and committed by
GitHub
36c3f4de 74d64c7f

+20 -20
+1 -1
docs/drivers/aw20216s.md
··· 44 44 45 45 ## LED Mapping {#led-mapping} 46 46 47 - In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`: 47 + In 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 49 ```c 50 50 const aw20216s_led_t PROGMEM g_aw20216s_leds[AW20216S_LED_COUNT] = {
+1 -1
docs/drivers/is31fl3218.md
··· 37 37 38 38 ## LED Mapping {#led-mapping} 39 39 40 - In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`: 40 + In 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 42 ```c 43 43 const is31fl3218_led_t PROGMEM g_is31fl3218_leds[IS31FL3218_LED_COUNT] = {
+1 -1
docs/drivers/is31fl3236.md
··· 50 50 51 51 ## LED Mapping {#led-mapping} 52 52 53 - In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`: 53 + In 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 55 ```c 56 56 const is31fl3236_led_t PROGMEM g_is31fl3236_leds[IS31FL3236_LED_COUNT] = {
+1 -1
docs/drivers/is31fl3729.md
··· 120 120 121 121 ## LED Mapping {#led-mapping} 122 122 123 - In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`: 123 + In 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 125 ```c 126 126 const is31fl3729_led_t PROGMEM g_is31fl3729_leds[IS31FL3729_LED_COUNT] = {
+1 -1
docs/drivers/is31fl3731.md
··· 61 61 62 62 ## LED Mapping {#led-mapping} 63 63 64 - In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`: 64 + In 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 66 ```c 67 67 const is31fl3731_led_t PROGMEM g_is31fl3731_leds[IS31FL3731_LED_COUNT] = {
+1 -1
docs/drivers/is31fl3733.md
··· 145 145 146 146 ## LED Mapping {#led-mapping} 147 147 148 - In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`: 148 + In 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 150 ```c 151 151 const is31fl3733_led_t PROGMEM g_is31fl3733_leds[IS31FL3733_LED_COUNT] = {
+1 -1
docs/drivers/is31fl3736.md
··· 129 129 130 130 ## LED Mapping {#led-mapping} 131 131 132 - In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`: 132 + In 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 134 ```c 135 135 const is31fl3736_led_t PROGMEM g_is31fl3736_leds[IS31FL3736_LED_COUNT] = {
+1 -1
docs/drivers/is31fl3737.md
··· 117 117 118 118 ## LED Mapping {#led-mapping} 119 119 120 - In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`: 120 + In 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 122 ```c 123 123 const is31fl3737_led_t PROGMEM g_is31fl3737_leds[IS31FL3737_LED_COUNT] = {
+1 -1
docs/drivers/is31fl3741.md
··· 117 117 118 118 ## LED Mapping {#led-mapping} 119 119 120 - In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`: 120 + In 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 122 ```c 123 123 const is31fl3741_led_t PROGMEM g_is31fl3741_leds[IS31FL3741_LED_COUNT] = {
+1 -1
docs/drivers/is31fl3742a.md
··· 117 117 118 118 ## LED Mapping {#led-mapping} 119 119 120 - In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`: 120 + In 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 122 ```c 123 123 const is31fl3742a_led_t PROGMEM g_is31fl3742a_leds[IS31FL3742A_LED_COUNT] = {
+1 -1
docs/drivers/is31fl3743a.md
··· 127 127 128 128 ## LED Mapping {#led-mapping} 129 129 130 - In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`: 130 + In 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 132 ```c 133 133 const is31fl3743a_led_t PROGMEM g_is31fl3743a_leds[IS31FL3743A_LED_COUNT] = {
+1 -1
docs/drivers/is31fl3745.md
··· 127 127 128 128 ## LED Mapping {#led-mapping} 129 129 130 - In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`: 130 + In 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 132 ```c 133 133 const is31fl3745_led_t PROGMEM g_is31fl3745_leds[IS31FL3745_LED_COUNT] = {
+1 -1
docs/drivers/is31fl3746a.md
··· 132 132 133 133 ## LED Mapping {#led-mapping} 134 134 135 - In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`: 135 + In 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 137 ```c 138 138 const is31fl3746a_led_t PROGMEM g_is31fl3746a_leds[IS31FL3746A_LED_COUNT] = {
+1 -1
docs/drivers/snled27351.md
··· 52 52 53 53 ## LED Mapping {#led-mapping} 54 54 55 - In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`: 55 + In 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 57 ```c 58 58 const snled27351_led_t PROGMEM g_snled27351_leds[SNLED27351_LED_COUNT] = {
+2 -2
docs/getting_started_introduction.md
··· 19 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 20 * `info.json`: The file used for setting layout for QMK Configurator. See [Configurator Support](reference_configurator_support) for more information. 21 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. 23 - * `<keyboardName>.c`: This file is where you can find custom code for the keyboard. 22 + * `<keyboard>.h`: This file is where the keyboard layout is defined against the keyboard's switch matrix. 23 + * `<keyboard>.c`: This file is where you can find custom code for the keyboard. 24 24 25 25 For more information on project structure, see [QMK Keyboard Guidelines](hardware_keyboard_guidelines). 26 26
+2 -2
docs/getting_started_make_guide.md
··· 1 1 # More Detailed `make` Instructions 2 2 3 - The full syntax of the `make` command is `<keyboard_folder>:<keymap>:<target>`, where: 3 + The 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 6 * Use `all` to compile all keyboards 7 7 * Specify the path to compile a revision, for example `planck/rev4` or `planck/rev3` 8 8 * If the keyboard doesn't have any folders, it can be left out
+2 -2
docs/hardware_keyboard_guidelines.md
··· 203 203 See `build_keyboard.mk` and `common_features.mk` for more details. 204 204 ::: 205 205 206 - ### `<keyboard.c>` 206 + ### `<keyboard>.c` 207 207 208 208 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. 209 209 ··· 214 214 * `bool process_record_kb(uint16_t keycode, keyrecord_t *record)` 215 215 * `bool led_update_kb(led_t led_state)` 216 216 217 - ### `<keyboard.h>` 217 + ### `<keyboard>.h` 218 218 219 219 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. 220 220