diff options
| author | Joel Challis <git@zvecr.com> | 2022-11-30 02:45:51 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-11-30 02:45:51 +0000 |
| commit | 4a0aa9ada2837762e3b4eab73950962365341cce (patch) | |
| tree | 176bf9a5ee5c105f664b2646a1ac539de231710d /docs/reference_info_json.md | |
| parent | 90fe668dd976743b33bbc30c7a560d827df21cc0 (diff) | |
Fix headers in info.json reference (#19202)
Diffstat (limited to 'docs/reference_info_json.md')
| -rw-r--r-- | docs/reference_info_json.md | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/docs/reference_info_json.md b/docs/reference_info_json.md index a96d9d4b6f..d5469c835a 100644 --- a/docs/reference_info_json.md +++ b/docs/reference_info_json.md | |||
| @@ -39,7 +39,7 @@ The `info.json` file is a JSON formatted dictionary. The first six keys noted he | |||
| 39 | 39 | ||
| 40 | ?> For all the available keys and their allowed values refer back to the [`data/schemas/keyboard.jsonschema`](https://github.com/qmk/qmk_firmware/blob/master/data/schemas/keyboard.jsonschema) file. | 40 | ?> For all the available keys and their allowed values refer back to the [`data/schemas/keyboard.jsonschema`](https://github.com/qmk/qmk_firmware/blob/master/data/schemas/keyboard.jsonschema) file. |
| 41 | 41 | ||
| 42 | ### Layout Format | 42 | ## Layout Format |
| 43 | 43 | ||
| 44 | Within our `info.json` file the `layouts` portion of the dictionary contains several nested dictionaries. The outer layer consists of QMK layout macros, for example `LAYOUT_ansi` or `LAYOUT_iso`. | 44 | Within our `info.json` file the `layouts` portion of the dictionary contains several nested dictionaries. The outer layer consists of QMK layout macros, for example `LAYOUT_ansi` or `LAYOUT_iso`. |
| 45 | 45 | ||
| @@ -68,11 +68,11 @@ All key positions and rotations are specified in relation to the top-left corner | |||
| 68 | * A two item list describing the row and column location for this key. | 68 | * A two item list describing the row and column location for this key. |
| 69 | * Example: `[0, 4]` | 69 | * Example: `[0, 4]` |
| 70 | 70 | ||
| 71 | ### Matrix Pins | 71 | ## Matrix Pins |
| 72 | 72 | ||
| 73 | Currently QMK supports connecting switches either directly to GPIO pins or via a switch matrix. At this time you can not combine these, they are mutually exclusive. | 73 | Currently QMK supports connecting switches either directly to GPIO pins or via a switch matrix. At this time you can not combine these, they are mutually exclusive. |
| 74 | 74 | ||
| 75 | #### Switch Matrix | 75 | ### Switch Matrix |
| 76 | 76 | ||
| 77 | Most keyboards use a switch matrix to connect keyswitches to the MCU. You can define your pin columns and rows to configure your switch matrix. When defining switch matrices you should also define your `diode_direction`. | 77 | Most keyboards use a switch matrix to connect keyswitches to the MCU. You can define your pin columns and rows to configure your switch matrix. When defining switch matrices you should also define your `diode_direction`. |
| 78 | 78 | ||
| @@ -88,7 +88,7 @@ Example: | |||
| 88 | } | 88 | } |
| 89 | ``` | 89 | ``` |
| 90 | 90 | ||
| 91 | #### Direct Pins | 91 | ### Direct Pins |
| 92 | 92 | ||
| 93 | Direct pins are when you connect one side of the switch to GND and the other side to a GPIO pin on your MCU. No diode is required, but there is a 1:1 mapping between switches and pins. | 93 | Direct pins are when you connect one side of the switch to GND and the other side to a GPIO pin on your MCU. No diode is required, but there is a 1:1 mapping between switches and pins. |
| 94 | 94 | ||
| @@ -250,7 +250,7 @@ The following animations can be enabled: | |||
| 250 | |`static_gradient`|Enable static gradient mode. | | 250 | |`static_gradient`|Enable static gradient mode. | |
| 251 | |`twinkle` |Enable twinkle animation mode. | | 251 | |`twinkle` |Enable twinkle animation mode. | |
| 252 | 252 | ||
| 253 | ### USB | 253 | ## USB |
| 254 | 254 | ||
| 255 | Every USB keyboard needs to have its USB parameters defined. At a minimum you need to set the Vendor ID, Product ID, and device version. | 255 | Every USB keyboard needs to have its USB parameters defined. At a minimum you need to set the Vendor ID, Product ID, and device version. |
| 256 | 256 | ||
| @@ -268,7 +268,7 @@ Example: | |||
| 268 | 268 | ||
| 269 | The device version is a BCD (binary coded decimal) value, in the format `MMmr`, so the below value would look like `0x0100` in the generated code. This also means the maximum valid values for each part are `99.9.9`, despite it being a hexadecimal value under the hood. | 269 | The device version is a BCD (binary coded decimal) value, in the format `MMmr`, so the below value would look like `0x0100` in the generated code. This also means the maximum valid values for each part are `99.9.9`, despite it being a hexadecimal value under the hood. |
| 270 | 270 | ||
| 271 | ### Encoders | 271 | ## Encoders |
| 272 | 272 | ||
| 273 | This section controls the basic [rotary encoder](feature_encoders.md) support. | 273 | This section controls the basic [rotary encoder](feature_encoders.md) support. |
| 274 | 274 | ||
| @@ -312,7 +312,7 @@ Examples: | |||
| 312 | } | 312 | } |
| 313 | ``` | 313 | ``` |
| 314 | 314 | ||
| 315 | ### Secure | 315 | ## Secure |
| 316 | 316 | ||
| 317 | The following options can be configured: | 317 | The following options can be configured: |
| 318 | 318 | ||
