kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

feat(docs): add documentation on &sleep behavior

Browse source
This commit is contained in:
KemoNine 2021-01-30 05:54:51 +00:00
parent 471d693f3a
commit 8e5e5b9dd7
1 changed files with 19 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
docs/docs/behaviors/misc.md
View file

@ -40,3 +40,22 @@ Example:
```
&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
```