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
@@ -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:
@@ -36,13 +36,13 @@ 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 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:
@@ -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:
@@ -77,14 +77,14 @@ You can use the following nodes to tweak the default behaviors:
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:
@@ -104,13 +104,13 @@ You can use the following nodes to tweak the default behaviors:
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:
@@ -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:
@@ -187,8 +187,8 @@ You can use the following nodes to tweak the default behaviors:
@ -58,7 +58,7 @@ ZMK will search the shield folder for the following config files:
@@ -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.
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
@@ -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.
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).
@ -5,7 +5,7 @@ sidebar_label: System
@@ -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.
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`:
@@ -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
@@ -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.