feat(docs): add documentation on &sleep behavior

zmkfirmware · Jan 30, 2021 · 0550b30 · 0550b30
1 parent 1b6d485
commit 0550b30
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/docs/docs/behaviors/misc.md b/docs/docs/behaviors/misc.md
@@ -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
+```