Jacob/zmk
1
0
Fork 0
forked from kofal.net/zmk
Code Pull Requests Activity

refactor(docs): Use .mdx for docs with mdx features

Browse Source 
Also applies prettier changes in touched files due to precommit
This commit is contained in:
Cem Aksoylar
2024-01-12 20:18:59 -08:00
parent 00962a7255
commit f014eb45a7
30 changed files with 162 additions and 146 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/docs/config/backlight.md
View File

@@ -3,7 +3,7 @@ title: Backlight Configuration
sidebar_label: Backlight
---
See the [backlight feature page](../features/backlight.md) for more details, including instructions for adding backlight support to a board.
See the [backlight feature page](../features/backlight.mdx) for more details, including instructions for adding backlight support to a board.
See [Configuration Overview](index.md) for instructions on how to change these settings.
@@ -37,4 +37,4 @@ See the Zephyr devicetree bindings for LED drivers:
- [gpio-leds](https://docs.zephyrproject.org/3.0.0/reference/devicetree/bindings/gpio/gpio-leds.html)
- [pwm-leds](https://docs.zephyrproject.org/latest/build/dts/api/bindings/led/pwm-leds.html)
See the [backlight feature page](../features/backlight.md) for examples of the properties that must be set to enable backlighting.
See the [backlight feature page](../features/backlight.mdx) for examples of the properties that must be set to enable backlighting.

6
docs/docs/config/behaviors.md
View File

@@ -49,7 +49,7 @@ You can use the following nodes to tweak the default behaviors:
Creates a custom behavior that triggers one behavior when a key is held or a different one when the key is tapped.
See the [hold-tap behavior](../behaviors/hold-tap.md) documentation for more details and examples.
See the [hold-tap behavior](../behaviors/hold-tap.mdx) documentation for more details and examples.
### Devicetree
@@ -77,7 +77,7 @@ The `flavor` property may be one of:
- `"tap-preferred"`
- `"tap-unless-interrupted"`
See the [hold-tap behavior documentation](../behaviors/hold-tap.md) for an explanation of each flavor.
See the [hold-tap behavior documentation](../behaviors/hold-tap.mdx) for an explanation of each flavor.
`hold-trigger-key-positions` is an array of zero-based key position indices.
@@ -243,7 +243,7 @@ You can use the following nodes to tweak the default behaviors:
Creates a custom behavior that triggers a different behavior corresponding to the number of times the key is tapped.
See the [tap dance behavior](../behaviors/tap-dance.md) documentation for more details and examples.
See the [tap dance behavior](../behaviors/tap-dance.mdx) documentation for more details and examples.
### Devicetree

2
docs/docs/config/combos.md
View File

@@ -33,7 +33,7 @@ Each child node can have the following properties:
| Property | Type | Description | Default |
| ----------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| `bindings` | phandle-array | A [behavior](../features/keymaps.md#behaviors) to run when the combo is triggered | |
| `bindings` | phandle-array | A [behavior](../features/keymaps.mdx#behaviors) to run when the combo is triggered | |
| `key-positions` | array | A list of key position indices for the keys which should trigger the combo | |
| `timeout-ms` | int | All the keys in `key-positions` must be pressed within this time in milliseconds to trigger the combo | 50 |
| `require-prior-idle-ms` | int | If any non-modifier key is pressed within `require-prior-idle-ms` before a key in the combo, the key will not be considered for the combo | -1 (disabled) |

2
docs/docs/config/index.md
View File

@@ -63,7 +63,7 @@ ZMK will search the shield folder for the following config files:
Shared config files (excluding any `_left` or `_right` suffix) are not currently supported in shield folders.
For more documentation on creating and configuring a new shield, see [Zephyr's shield documentation](https://docs.zephyrproject.org/latest/hardware/porting/shields.html) and [ZMK's new keyboard shield](../development/new-shield.md) guide.
For more documentation on creating and configuring a new shield, see [Zephyr's shield documentation](https://docs.zephyrproject.org/latest/hardware/porting/shields.html) and [ZMK's new keyboard shield](../development/new-shield.mdx) guide.
## Kconfig Files

10
docs/docs/config/keymap.md
View File

@@ -17,11 +17,11 @@ The `zmk,keymap` node itself has no properties. It should have one child node pe
Each child node can have the following properties:
| Property | Type | Description |
| ----------------- | ------------- | ---------------------------------------------------------------------- |
| `display-name` | string | Name for the layer on displays |
| `bindings` | phandle-array | List of [key behaviors](../features/keymaps.md#behaviors), one per key |
| `sensor-bindings` | phandle-array | List of sensor behaviors, one per sensor |
| Property | Type | Description |
| ----------------- | ------------- | ----------------------------------------------------------------------- |
| `display-name` | string | Name for the layer on displays |
| `bindings` | phandle-array | List of [key behaviors](../features/keymaps.mdx#behaviors), one per key |
| `sensor-bindings` | phandle-array | List of sensor behaviors, one per sensor |
Items for `bindings` must be listed in the order the keys are defined in the [keyboard scan configuration](kscan.md).

2
docs/docs/config/kscan.md
View File

@@ -320,7 +320,7 @@ Transforms should be used any time the physical layout of a keyboard's keys does
Transforms can also be used for keyboards with multiple layouts. You can define multiple matrix transform nodes, one for each layout, and users can select which one they want from the `/chosen` node in their keymaps.
See the [new shield guide](../development/new-shield.md#optional-matrix-transform) for more documentation on how to define a matrix transform.
See the [new shield guide](../development/new-shield.mdx#optional-matrix-transform) for more documentation on how to define a matrix transform.
### Devicetree