feat(docs): add documentation on &sleep behavior
This commit is contained in:
parent
471d693f3a
commit
8e5e5b9dd7
1 changed files with 19 additions and 0 deletions
|
@ -40,3 +40,22 @@ Example:
|
||||||
```
|
```
|
||||||
&none
|
&none
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Sleep
|
||||||
|
|
||||||
|
The sleep behavior simply puts your keyboard to sleep. This behavior has the same effect as letting the sleep timer expire.
|
||||||
|
|
||||||
|
:::note
|
||||||
|
You'll need to enable `CONFIG_ZMK_SLEEP` in your boards config for this keycode to work.
|
||||||
|
:::
|
||||||
|
|
||||||
|
### Behavior Binding
|
||||||
|
|
||||||
|
- Reference: `&sleep`
|
||||||
|
- Parameters: None
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
```
|
||||||
|
&sleep
|
||||||
|
```
|
||||||
|
|
Loading…
Add table
Reference in a new issue