[Docs] Clean up reference_info_json.md (#14806)
parent
dd42387d9f
commit
b7a346600c
|
@ -11,12 +11,18 @@ The `info.json` file is a JSON formatted dictionary with the following keys avai
|
||||||
* `keyboard_name`
|
* `keyboard_name`
|
||||||
* A free-form text string describing the keyboard.
|
* A free-form text string describing the keyboard.
|
||||||
* Example: `Clueboard 66%`
|
* Example: `Clueboard 66%`
|
||||||
|
* `manufacturer`
|
||||||
|
* A free-form text string describing the keyboard's manufacturer.
|
||||||
|
* Example: `Clueboard`
|
||||||
* `url`
|
* `url`
|
||||||
* A URL to the keyboard's product page, [QMK.fm/keyboards](https://qmk.fm/keyboards) page, or other page describing information about the keyboard.
|
* A URL to the keyboard's product page, [QMK.fm/keyboards](https://qmk.fm/keyboards) page, or other page describing information about the keyboard.
|
||||||
|
* Example: `https://clueboard.co`
|
||||||
* `maintainer`
|
* `maintainer`
|
||||||
* GitHub username of the maintainer, or `qmk` for community maintained boards
|
* GitHub username of the maintainer, or `qmk` for community maintained boards.
|
||||||
|
* Example: `skullydazed`
|
||||||
* `debounce`
|
* `debounce`
|
||||||
* How many milliseconds (ms) to wait for debounce to happen. (Default: 5)
|
* The amount of time in milliseconds to wait for debounce to happen.
|
||||||
|
* Default: `5`
|
||||||
* `diode_direction`
|
* `diode_direction`
|
||||||
* The direction diodes face. See [`DIRECT_PINS` in the hardware configuration](https://docs.qmk.fm/#/config_options?id=hardware-options) for more details.
|
* The direction diodes face. See [`DIRECT_PINS` in the hardware configuration](https://docs.qmk.fm/#/config_options?id=hardware-options) for more details.
|
||||||
* `layout_aliases`
|
* `layout_aliases`
|
||||||
|
@ -24,11 +30,11 @@ The `info.json` file is a JSON formatted dictionary with the following keys avai
|
||||||
* `layouts`
|
* `layouts`
|
||||||
* Physical Layout representations. See the [Layout Format](#layout_format) section for more detail.
|
* Physical Layout representations. See the [Layout Format](#layout_format) section for more detail.
|
||||||
* `matrix_pins`
|
* `matrix_pins`
|
||||||
* Configure the pins corresponding to columns and rows, or direct pins. See [Matrix Pins](#matrix_pins) for more detail.
|
* Configure the pins corresponding to columns and rows, or direct pins. See the [Matrix Pins](#matrix_pins) section for more detail.
|
||||||
* `rgblight`
|
* `rgblight`
|
||||||
* Configure the [RGB Lighting feature](feature_rgblight.md). See the [RGB Lighting](#rgb_lighting) section for more detail.
|
* Configure the [RGB Lighting feature](feature_rgblight.md). See the [RGB Lighting](#rgb_lighting) section for more detail.
|
||||||
* `usb`
|
* `usb`
|
||||||
* Configure USB VID, PID, and other parameters. See [USB](#USB) for more detail.
|
* Configure USB VID, PID, and other parameters. See the [USB](#USB) section for more detail.
|
||||||
|
|
||||||
### Layout Format
|
### Layout Format
|
||||||
|
|
||||||
|
@ -44,18 +50,20 @@ Each Key Dictionary in a layout describes the physical properties of a key. If y
|
||||||
All key positions and rotations are specified in relation to the top-left corner of the keyboard, and the top-left corner of each key.
|
All key positions and rotations are specified in relation to the top-left corner of the keyboard, and the top-left corner of each key.
|
||||||
|
|
||||||
* `x`
|
* `x`
|
||||||
* **Required**: The absolute position of the key in the horizontal axis, in Key Units.
|
* **Required**. The absolute position of the key in the horizontal axis, in Key Units.
|
||||||
* `y`
|
* `y`
|
||||||
* **Required**: The absolute position of the key in the vertical axis, in Key Units.
|
* **Required**. The absolute position of the key in the vertical axis, in Key Units.
|
||||||
* `w`
|
* `w`
|
||||||
* The width of the key, in Key Units. Ignored if `ks` is provided. Default: `1`
|
* The width of the key, in Key Units.
|
||||||
|
* Default: `1`
|
||||||
* `h`
|
* `h`
|
||||||
* The height of the key, in Key Units. Ignored if `ks` is provided. Default: `1`
|
* The height of the key, in Key Units.
|
||||||
|
* Default: `1`
|
||||||
* `label`
|
* `label`
|
||||||
* What to name this position in the matrix.
|
* What to name this position in the matrix. This should usually correspond to the keycode for the first layer of the default keymap.
|
||||||
* This should usually correspond to the keycode for the first layer of the default keymap.
|
|
||||||
* `matrix`
|
* `matrix`
|
||||||
* A 2 item list describing the row and column location for this key.
|
* A two item list describing the row and column location for this key.
|
||||||
|
* Example: `[0, 4]`
|
||||||
|
|
||||||
### Matrix Pins
|
### Matrix Pins
|
||||||
|
|
||||||
|
@ -149,7 +157,7 @@ Example:
|
||||||
The following animations can be enabled:
|
The following animations can be enabled:
|
||||||
|
|
||||||
|Key |Description |
|
|Key |Description |
|
||||||
|-----|-------------|
|
|-----------------|--------------------------------------|
|
||||||
|`all` |Enable all additional animation modes.|
|
|`all` |Enable all additional animation modes.|
|
||||||
|`alternating` |Enable alternating animation mode. |
|
|`alternating` |Enable alternating animation mode. |
|
||||||
|`breathing` |Enable breathing animation mode. |
|
|`breathing` |Enable breathing animation mode. |
|
||||||
|
|
Loading…
Reference in New Issue