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

refactor(docs): Refer to overview page for behaviors

Browse Source
This commit is contained in:
Cem Aksoylar
2024-03-24 17:58:20 -07:00
parent f2d8b9b0a3
commit c684cee76f
3 changed files with 4 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/docs/features/keymaps.mdx
View File

@@ -33,7 +33,7 @@ For example, the simplest behavior in ZMK is the "key press" behavior, which res
(a certain spot on the keyboard), and when that position is pressed, send a keycode to the host, and
when the key position is released, updates the host to notify of the keycode being released.
For the full set of possible behaviors, start at the [Key Press](../behaviors/key-press.md) behavior.
For the full set of possible behaviors, see the [overview page for behaviors](../behaviors/index.mdx).
## Layers
@@ -128,11 +128,9 @@ that defines just one layer for this keymap:
Each layer should have:
1. A `bindings` property this will be a list of behavior bindings, one for each key position for the keyboard.
1. A `bindings` property this will be a list of [behavior bindings](../behaviors/index.mdx), one for each key position for the keyboard.
1. (Optional) A `sensor-bindings` property that will be a list of behavior bindings for each sensor on the keyboard. (Currently, only encoders are supported as sensor hardware, but in the future devices like trackpoints would be supported the same way)
For the full set of possible behaviors, start at the [Key Press](../behaviors/key-press.md) behavior.
### Complete Example
Putting this all together, a complete [`kyria.keymap`](https://github.com/zmkfirmware/zmk/blob/main/app/boards/shields/kyria/kyria.keymap) looks like: