fix(docs): Fix links in config pages
This commit is contained in:
Joel Spadin
Dom H
parent
2b122acfc3
commit
c350f7130b
|
|
@ -3,9 +3,9 @@ title: Backlight Configuration
|
|||
sidebar_label: Backlight
|
||||
---
|
||||
|
||||
See the [backlight feature page](/docs/features/backlight) for more details, including instructions for adding backlight support to a board.
|
||||
See the [backlight feature page](../features/backlight.md) for more details, including instructions for adding backlight support to a board.
|
||||
|
||||
See [Configuration Overview](/docs/config) for instructions on how to change these settings.
|
||||
See [Configuration Overview](index.md) for instructions on how to change these settings.
|
||||
|
||||
## Kconfig
|
||||
|
||||
|
|
@ -33,4 +33,4 @@ See the Zephyr devicetree bindings for LED drivers:
|
|||
- [gpio-leds](https://docs.zephyrproject.org/latest/build/dts/api/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](/docs/features/backlight) for examples of the properties that must be set to enable backlighting.
|
||||
See the [backlight feature page](../features/backlight.md) for examples of the properties that must be set to enable backlighting.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ sidebar_label: Behaviors
|
|||
|
||||
Some behaviors have properties to adjust how they behave. These can also be used as templates to create custom behaviors when none of the built-in behaviors do what you want.
|
||||
|
||||
See [Configuration Overview](/docs/config/index) for instructions on how to change these settings.
|
||||
See [Configuration Overview](index.md) for instructions on how to change these settings.
|
||||
|
||||
See the [zmk/app/dts/behaviors/](https://github.com/zmkfirmware/zmk/tree/main/app/dts/behaviors) folder for all default behaviors.
|
||||
|
||||
|
|
@ -13,7 +13,7 @@ See the [zmk/app/dts/behaviors/](https://github.com/zmkfirmware/zmk/tree/main/ap
|
|||
|
||||
Creates a custom behavior that behaves similar to a caps lock but deactivates when any key not in a continue list is pressed.
|
||||
|
||||
See the [caps word behavior](/docs/behaviors/caps-word) documentation for more details and examples.
|
||||
See the [caps word behavior](../behaviors/caps-word.md) documentation for more details and examples.
|
||||
|
||||
### Devicetree
|
||||
|
||||
|
|
@ -36,13 +36,13 @@ You can use the following nodes to tweak the default behaviors:
|
|||
|
||||
| Node | Behavior |
|
||||
| ------------ | -------------------------------------- |
|
||||
| `&caps_word` | [Caps Word](/docs/behaviors/caps-word) |
|
||||
| `&caps_word` | [Caps Word](../behaviors/caps-word.md) |
|
||||
|
||||
## Hold-Tap
|
||||
|
||||
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 documentation](/docs/behaviors/hold-tap) for more details and examples.
|
||||
See the [hold-tap behavior documentation](../behaviors/hold-tap.md) for more details and examples.
|
||||
|
||||
### Devicetree
|
||||
|
||||
|
|
@ -69,7 +69,7 @@ The `flavor` property may be one of:
|
|||
- `"tap-preferred"`
|
||||
- `"tap-unless-interrupted"`
|
||||
|
||||
See the [hold-tap behavior documentation](/docs/behaviors/hold-tap) for an explanation of each flavor.
|
||||
See the [hold-tap behavior documentation](../behaviors/hold-tap.md) for an explanation of each flavor.
|
||||
|
||||
`hold-trigger-key-positions` is an array of zero-based key position indices.
|
||||
|
||||
|
|
@ -77,14 +77,14 @@ You can use the following nodes to tweak the default behaviors:
|
|||
|
||||
| Node | Behavior |
|
||||
| ----- | --------------------------------------------- |
|
||||
| `<` | [Layer-tap](/docs/behaviors/layers#layer-tap) |
|
||||
| `&mt` | [Mod-tap](/docs/behaviors/mod-tap) |
|
||||
| `<` | [Layer-tap](../behaviors/layers.md#layer-tap) |
|
||||
| `&mt` | [Mod-tap](../behaviors/mod-tap.md) |
|
||||
|
||||
## Key Repeat
|
||||
|
||||
Creates a custom behavior that repeats the whatever key code was last sent.
|
||||
|
||||
See the [key repeat behavior](/docs/behaviors/key-repeat) documentation for more details and examples.
|
||||
See the [key repeat behavior](../behaviors/key-repeat.md) documentation for more details and examples.
|
||||
|
||||
### Devicetree
|
||||
|
||||
|
|
@ -104,13 +104,13 @@ You can use the following nodes to tweak the default behaviors:
|
|||
|
||||
| Node | Behavior |
|
||||
| ------------- | ---------------------------------------- |
|
||||
| `&key_repeat` | [Key repeat](/docs/behaviors/key-repeat) |
|
||||
| `&key_repeat` | [Key repeat](../behaviors/key-repeat.md) |
|
||||
|
||||
## Macro
|
||||
|
||||
Creates a custom behavior which triggers a sequence of other behaviors.
|
||||
|
||||
See the [macro behavior](/docs/behaviors/macros) documentation for more details and examples.
|
||||
See the [macro behavior](../behaviors/macros.md) documentation for more details and examples.
|
||||
|
||||
### Devicetree
|
||||
|
||||
|
|
@ -166,7 +166,7 @@ You can use the following nodes to tweak the default behaviors:
|
|||
|
||||
Creates a custom behavior that triggers a behavior and keeps it pressed it until another key is pressed and released.
|
||||
|
||||
See the [sticky key behavior](/docs/behaviors/sticky-key) and [sticky layer behavior](/docs/behaviors/sticky-layer) documentation for more details and examples.
|
||||
See the [sticky key behavior](../behaviors/sticky-key.md) and [sticky layer behavior](../behaviors/sticky-layer.md) documentation for more details and examples.
|
||||
|
||||
### Devicetree
|
||||
|
||||
|
|
@ -187,8 +187,8 @@ You can use the following nodes to tweak the default behaviors:
|
|||
|
||||
| Node | Behavior |
|
||||
| ----- | -------------------------------------------- |
|
||||
| `&sk` | [Sticky key](/docs/behaviors/sticky-key) |
|
||||
| `&sl` | [Sticky layer](/docs/behaviors/sticky-layer) |
|
||||
| `&sk` | [Sticky key](../behaviors/sticky-key.md) |
|
||||
| `&sl` | [Sticky layer](../behaviors/sticky-layer.md) |
|
||||
|
||||
## Tap Dance
|
||||
|
||||
|
|
|
|||
|
|
@ -3,9 +3,9 @@ title: Combo Configuration
|
|||
sidebar_label: Combos
|
||||
---
|
||||
|
||||
See the [Combos feature page](/docs/features/combos) for more details and examples.
|
||||
See the [Combos feature page](../features/combos.md) for more details and examples.
|
||||
|
||||
See [Configuration Overview](/docs/config/index) for instructions on how to change these settings.
|
||||
See [Configuration Overview](index.md) for instructions on how to change these settings.
|
||||
|
||||
## Kconfig
|
||||
|
||||
|
|
@ -33,7 +33,7 @@ Each child node can have the following properties:
|
|||
|
||||
| Property | Type | Description | Default |
|
||||
| --------------- | ------------- | ---------------------------------------------------------------------------------- | ------- |
|
||||
| `bindings` | phandle-array | A [behavior](/docs/features/keymaps#behaviors) to run when the combo is triggered | |
|
||||
| `bindings` | phandle-array | A [behavior](../features/keymaps.md#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 must be pressed within this time in milliseconds to trigger the combo | 50 |
|
||||
| `slow-release` | bool | Releases the combo when all keys are released instead of when any key is released | false |
|
||||
|
|
|
|||
|
|
@ -3,9 +3,9 @@ title: Display Configuration
|
|||
sidebar_label: Displays
|
||||
---
|
||||
|
||||
See the [displays feature page](/docs/features/displays) for more details.
|
||||
See the [displays feature page](../features/displays.md) for more details.
|
||||
|
||||
See [Configuration Overview](/docs/config/index) for instructions on how to change these settings.
|
||||
See [Configuration Overview](index.md) for instructions on how to change these settings.
|
||||
|
||||
## Kconfig
|
||||
|
||||
|
|
|
|||
|
|
@ -3,9 +3,9 @@ title: Encoder Configuration
|
|||
sidebar_label: Encoders
|
||||
---
|
||||
|
||||
See the [Encoders feature page](/docs/features/encoders) for more details, including instructions for adding encoder support to a board.
|
||||
See the [Encoders feature page](../features/encoders.md) for more details, including instructions for adding encoder support to a board.
|
||||
|
||||
See [Configuration Overview](/docs/config/index) for instructions on how to change these settings.
|
||||
See [Configuration Overview](index.md) for instructions on how to change these settings.
|
||||
|
||||
## EC11 Encoders
|
||||
|
||||
|
|
|
|||
|
|
@ -58,7 +58,7 @@ ZMK will search the shield folder for the following config files:
|
|||
- `<shield>.overlay` (Devicetree)
|
||||
- `<shield>.keymap` (Devicetree)
|
||||
|
||||
For more documentation on creating and configuring a new shield, see [Zephyr's shield documentation](https://docs.zephyrproject.org/latest/guides/porting/shields.html) and [ZMK's new keyboard shield](/docs/development/new-shield) 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.md) guide.
|
||||
|
||||
## Kconfig Files
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ title: Keymap Configuration
|
|||
sidebar_label: Keymap
|
||||
---
|
||||
|
||||
See [Configuration Overview](/docs/config/index) for instructions on how to change these settings.
|
||||
See [Configuration Overview](index.md) for instructions on how to change these settings.
|
||||
|
||||
## Keymap
|
||||
|
||||
|
|
@ -20,10 +20,10 @@ Each child node can have the following properties:
|
|||
| Property | Type | Description |
|
||||
| ----------------- | ------------- | ---------------------------------------------------------------------- |
|
||||
| `label` | string | Unique label for the node |
|
||||
| `bindings` | phandle-array | List of [key behaviors](/docs/features/keymaps#behaviors), one per key |
|
||||
| `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 |
|
||||
|
||||
Items for `bindings` must be listed in the order the keys are defined in the [keyboard scan configuration](/docs/config/kscan).
|
||||
Items for `bindings` must be listed in the order the keys are defined in the [keyboard scan configuration](kscan.md).
|
||||
|
||||
Items for `sensor-bindings` must be listed in the order the [sensors](#keymap-sensors) are defined.
|
||||
|
||||
|
|
@ -39,4 +39,4 @@ Applies to: `compatible = "zmk,keymap-sensors"`
|
|||
|
||||
The following types of nodes can be used as a sensor:
|
||||
|
||||
- [`alps,ec11`](/docs/config/encoders#ec11-encoders)
|
||||
- [`alps,ec11`](encoders.md#ec11-encoders)
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ title: Keyboard Scan Configuration
|
|||
sidebar_label: Keyboard Scan
|
||||
---
|
||||
|
||||
See [Configuration Overview](/docs/config/index) for instructions on how to change these settings.
|
||||
See [Configuration Overview](index.md) for instructions on how to change these settings.
|
||||
|
||||
## Common
|
||||
|
||||
|
|
@ -250,7 +250,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](/docs/development/new-shield/#optional-matrix-transform) for more documentation on how to define a matrix transform.
|
||||
See the [new shield guide](../development/new-shield.md#optional-matrix-transform) for more documentation on how to define a matrix transform.
|
||||
|
||||
### Devicetree
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ title: Power Management Configuration
|
|||
sidebar_label: Power Management
|
||||
---
|
||||
|
||||
See [Configuration Overview](/docs/config/index) for instructions on how to
|
||||
See [Configuration Overview](index.md) for instructions on how to
|
||||
change these settings.
|
||||
|
||||
## Idle/Sleep
|
||||
|
|
@ -26,7 +26,7 @@ Definition file: [zmk/app/Kconfig](https://github.com/zmkfirmware/zmk/blob/main/
|
|||
|
||||
## External Power Control
|
||||
|
||||
Driver for enabling or disabling power to peripherals such as displays and lighting. This driver must be configured to use [power management behaviors](/docs/behaviors/power).
|
||||
Driver for enabling or disabling power to peripherals such as displays and lighting. This driver must be configured to use [power management behaviors](../behaviors/power.md).
|
||||
|
||||
### Kconfig
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ sidebar_label: System
|
|||
|
||||
These are general settings that control how the keyboard behaves and which features it supports. Several of these settings come from Zephyr and are not specific to ZMK, but they are listed here because they are relevant to how a keyboard functions.
|
||||
|
||||
See [Configuration Overview](/docs/config/index) for instructions on how to change these settings.
|
||||
See [Configuration Overview](index.md) for instructions on how to change these settings.
|
||||
|
||||
## Kconfig
|
||||
|
||||
|
|
|
|||
|
|
@ -3,9 +3,9 @@ title: RGB Underglow Configuration
|
|||
sidebar_label: RGB Underglow
|
||||
---
|
||||
|
||||
See the [RGB Underglow feature page](/docs/features/underglow) for more details, including instructions for adding underglow support to a board.
|
||||
See the [RGB Underglow feature page](../features/underglow.md) for more details, including instructions for adding underglow support to a board.
|
||||
|
||||
See [Configuration Overview](/docs/config) for instructions on how to change these settings.
|
||||
See [Configuration Overview](index.md) for instructions on how to change these settings.
|
||||
|
||||
## Kconfig
|
||||
|
||||
|
|
@ -40,4 +40,4 @@ Values for `CONFIG_ZMK_RGB_UNDERGLOW_EFF_START`:
|
|||
|
||||
ZMK does not have any Devicetree properties of its own. See the Devicetree bindings for [Zephyr's LED strip drivers](https://github.com/zephyrproject-rtos/zephyr/tree/main/dts/bindings/led_strip).
|
||||
|
||||
See the [RGB underglow feature page](/docs/features/underglow) for examples of the properties that must be set to enable underglow.
|
||||
See the [RGB underglow feature page](../features/underglow.md) for examples of the properties that must be set to enable underglow.
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ The setup script creates a `config/<shield>.conf` file that allows you to add ad
|
|||
control what features and options are built into your firmware. Opening that file with your text editor will allow you to see the
|
||||
various config settings that can be commented/uncommented to modify how your firmware is built.
|
||||
|
||||
Refer to the [Configuration](/docs/config/index) documentation for more details on this file.
|
||||
Refer to the [Configuration](/docs/config) documentation for more details on this file.
|
||||
|
||||
## Keymap
|
||||
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ CONFIG_ZMK_RGB_UNDERGLOW=y
|
|||
CONFIG_WS2812_STRIP=y
|
||||
```
|
||||
|
||||
See [Configuration Overview](/docs/config/index) for more instructions on how to
|
||||
See [Configuration Overview](/docs/config) for more instructions on how to
|
||||
use Kconfig.
|
||||
|
||||
If your board or shield does not have RGB underglow configured, refer to [Adding RGB Underglow to a Board](#adding-rgb-underglow-to-a-board).
|
||||
|
|
|
|||
Loading…
Reference in New Issue