pwarren/zmk_mf68
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

fix(docs): Better behavior sidebar label/titles.

Browse source
This commit is contained in:
Pete Johanson 2020-08-21 00:31:28 -04:00
parent 63a408d2a0
commit 1ff13676f7
5 changed files with 17 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/docs/behavior/key-press.md
View file

@ -1,5 +1,6 @@
--- ---
title: Key Presses title: Key Press Behaviors
sidebar_label: Key Press
--- ---
## Summary ## Summary

8
docs/docs/behavior/layers.md
View file

@ -1,5 +1,6 @@
--- ---
title: Layers title: Layer Behaviors
sidebar_label: Layers
--- ---
## Summary ## Summary
@ -56,12 +57,13 @@ Example:
``` ```
"Toggle layer" for a : "Toggle layer" for a :
``` ```
#define DEFAULT 0 #define DEFAULT 0
#define NAVI 1 #define NAVI 1
#define NONE 0 #define NONE 0
/ { / {
keymap { keymap {
compatible = "zmk,keymap"; compatible = "zmk,keymap";
@ -89,4 +91,4 @@ Example:
}; };
``` ```
It is possible to use "toggle layer" to have keys that raise and lower the layers as well. It is possible to use "toggle layer" to have keys that raise and lower the layers as well.

11
docs/docs/behavior/lighting.md
View file

@ -1,15 +1,16 @@
--- ---
title: Lighting title: Lighting Behavior
sidebar_label: Lighting
--- ---
## Summary ## Summary
Lighting is often used for either aesthetics or for the practical purposes of lighting up keys in the dark. Lighting is often used for either aesthetics or for the practical purposes of lighting up keys in the dark.
Currently ZMK supports RGB underglow, which can be changed and configured using its behavior. Currently ZMK supports RGB underglow, which can be changed and configured using its behavior.
## RGB Action Defines ## RGB Action Defines
RGB actions defines are provided through the [`dt-bindings/zmk/rgb.h`](https://github.com/zmkfirmware/zmk/blob/main/app/include/dt-bindings/zmk/rgb.h) header, RGB actions defines are provided through the [`dt-bindings/zmk/rgb.h`](https://github.com/zmkfirmware/zmk/blob/main/app/include/dt-bindings/zmk/rgb.h) header,
which is added at the top of the keymap file: which is added at the top of the keymap file:
``` ```
@ -21,7 +22,7 @@ This will allow you to reference the actions defined in this header such as `RGB
Here is a table describing the action for each define: Here is a table describing the action for each define:
| Define | Action | | Define | Action |
|-----------|-----------------------------------------------------------| | --------- | --------------------------------------------------------- |
| `RGB_TOG` | Toggles the RGB feature on and off | | `RGB_TOG` | Toggles the RGB feature on and off |
| `RGB_HUI` | Increases the hue of the RGB feature | | `RGB_HUI` | Increases the hue of the RGB feature |
| `RGB_HUD` | Decreases the hue of the RGB feature | | `RGB_HUD` | Decreases the hue of the RGB feature |
@ -47,4 +48,4 @@ Example:
``` ```
&rgb_ug RGB_TOG &rgb_ug RGB_TOG
``` ```

3
docs/docs/behavior/misc.md
View file

@ -1,5 +1,6 @@
--- ---
title: Miscellaneous title: Miscellaneous Behaviors
sidebar_label: Miscellaneous
--- ---
## Summary ## Summary

3
docs/docs/behavior/mod-tap.md
View file

@ -1,5 +1,6 @@
--- ---
title: Mod-Tap title: Mod-Tap Behavior
sidebar_label: Mod-Tap
--- ---
## Summary ## Summary