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

docs: Remove label property from documentation

Browse source
This commit is contained in:
Joel Spadin 2023-10-06 20:49:58 -05:00
parent d4e8dee444
commit 5ecd3521f5
24 changed files with 51 additions and 83 deletions
Download patch file Download diff file Expand all files Collapse all files

3
docs/docs/behaviors/caps-word.md
View file

@ -59,9 +59,8 @@ If you want to use multiple caps breaks with different codes to break the caps,
```dts
/ {
prog_caps: behavior_prog_caps_word {
prog_caps: prog_caps {
compatible = "zmk,behavior-caps-word";
label = "PROG_CAPS";
#binding-cells = <0>;
continue-list = <UNDERSCORE>;
};

10
docs/docs/behaviors/hold-tap.md
View file

@ -58,7 +58,6 @@ For example, the following hold-tap configuration enables `require-prior-idle-ms
```dts
rpi: require_prior_idle {
compatible = "zmk,behavior-hold-tap";
label = "REQUIRE_PRIOR_IDLE";
#binding-cells = <2>;
flavor = "tap-preferred";
tapping-term-ms = <200>;
@ -104,7 +103,6 @@ See the following example, which uses a hold-tap behavior definition, configured
behaviors {
pht: positional_hold_tap {
compatible = "zmk,behavior-hold-tap";
label = "POSITIONAL_HOLD_TAP";
#binding-cells = <2>;
flavor = "hold-preferred";
tapping-term-ms = <400>;
@ -115,7 +113,6 @@ See the following example, which uses a hold-tap behavior definition, configured
};
keymap {
compatible = "zmk,keymap";
label ="Default keymap";
default_layer {
bindings = <
// position 0 position 1 position 2
@ -172,9 +169,8 @@ The following are suggested hold-tap configurations that work well with home row
/ {
behaviors {
lh_pht: left_hand_positional_hold_tap {
lh_pht: left_positional_hold_tap {
compatible = "zmk,behavior-hold-tap";
label = "LEFT_POSITIONAL_HOLD_TAP";
#binding-cells = <2>;
flavor = "tap-unless-interrupted";
tapping-term-ms = <100>; // <---[[produces tap if held longer than tapping-term-ms]]
@ -206,7 +202,6 @@ The following are suggested hold-tap configurations that work well with home row
behaviors {
hm: homerow_mods {
compatible = "zmk,behavior-hold-tap";
label = "HOMEROW_MODS";
#binding-cells = <2>;
tapping-term-ms = <150>;
quick-tap-ms = <0>;
@ -236,7 +231,6 @@ The following are suggested hold-tap configurations that work well with home row
behaviors {
bhm: balanced_homerow_mods {
compatible = "zmk,behavior-hold-tap";
label = "HOMEROW_MODS";
#binding-cells = <2>;
tapping-term-ms = <200>; // <---[[moderate duration]]
quick-tap-ms = <0>;
@ -272,7 +266,6 @@ A popular method of implementing Autoshift in ZMK involves a C-preprocessor macr
behaviors {
as: auto_shift {
compatible = "zmk,behavior-hold-tap";
label = "AUTO_SHIFT";
#binding-cells = <2>;
tapping_term_ms = <135>;
quick_tap_ms = <0>;
@ -308,7 +301,6 @@ This hold-tap example implements a [momentary-layer](layers.md/#momentary-layer)
behaviors {
mo_tog: behavior_mo_tog {
compatible = "zmk,behavior-hold-tap";
label = "mo_tog";
#binding-cells = <2>;
flavor = "hold-preferred";
tapping-term-ms = <200>;

3
docs/docs/behaviors/macros.md
View file

@ -18,7 +18,6 @@ A macro definition looks like:
/ {
macros {
zed_em_kay: zed_em_kay {
label = "ZM_zed_em_kay";
compatible = "zmk,behavior-macro";
#binding-cells = <0>;
bindings
@ -239,7 +238,6 @@ To achieve this, a combination of a 0ms wait time and splitting the press and re
* `&lm NUM_LAYER LSHIFT`
*/
lm: lm {
label = "LAYER_MOD";
compatible = "zmk,behavior-macro-two-param";
wait-ms = <0>;
tap-ms = <0>;
@ -323,7 +321,6 @@ This can be used instead of a complete macro definition. During the firmware bui
```dts
my_zero_param_macro: my_zero_param_macro {
compatible = "zmk,behavior-macro";
label = "ZM_my_macro";
#binding-cells = <0>;
wait-ms = <30>;
tap-ms = <40>;

2
docs/docs/behaviors/mod-morph.md
View file

@ -23,7 +23,6 @@ An example of how to implement the mod-morph "Grave Escape":
behaviors {
gresc: grave_escape {
compatible = "zmk,behavior-mod-morph";
label = "GRAVE_ESCAPE";
#binding-cells = <0>;
bindings = <&kp ESC>, <&kp GRAVE>;
mods = <(MOD_LGUI|MOD_LSFT|MOD_RGUI|MOD_RSFT)>;
@ -79,7 +78,6 @@ For example, the following configuration morphs `LEFT_SHIFT` + `BACKSPACE` into
behaviors {
bspc_del: backspace_delete {
compatible = "zmk,behavior-mod-morph";
label = "BACKSPACE_DELETE";
#binding-cells = <0>;
bindings = <&kp BACKSPACE>, <&kp DELETE>;
mods = <(MOD_LSFT|MOD_RSFT)>;

4
docs/docs/behaviors/sensor-rotate.md
View file

@ -24,7 +24,6 @@ Here is an example that binds the [RGB Underglow Behavior](/docs/behaviors/under
behaviors {
rgb_encoder: rgb_encoder {
compatible = "zmk,behavior-sensor-rotate";
label = "RGB_ENCODER";
#sensor-binding-cells = <0>;
bindings = <&rgb_ug RGB_BRI>, <&rgb_ug RGB_BRD>;
};
@ -58,9 +57,8 @@ First, defining the sensor rotation itself, binding the [Key Press Behavior](/do
```dts
/ {
behaviors {
rot_kp: behavior_sensor_rotate_kp {
rot_kp: sensor_rotate_kp {
compatible = "zmk,behavior-sensor-rotate-var";
label = "ENC_KP";
#sensor-binding-cells = <2>;
bindings = <&kp>, <&kp>;
};

1
docs/docs/behaviors/sticky-key.md
View file

@ -61,7 +61,6 @@ This configuration would apply to all sticky keys. This may not be appropriate i
behaviors {
skq: sticky_key_quick_release {
compatible = "zmk,behavior-sticky-key";
label = "STICKY_KEY_QUICK_RELEASE";
#binding-cells = <1>;
bindings = <&kp>;
release-after-ms = <1000>;

2
docs/docs/behaviors/tap-dance.md
View file

@ -45,7 +45,6 @@ This example configures a tap-dance named `td0` that outputs the number of times
behaviors {
td0: tap_dance_0 {
compatible = "zmk,behavior-tap-dance";
label = "TAP_DANCE_0";
#binding-cells = <0>;
tapping-term-ms = <200>;
bindings = <&kp N1>, <&kp N2>, <&kp N3>;
@ -86,7 +85,6 @@ This example configures a mod-tap inside a tap-dance named `td_mt` that outputs
behaviors {
td_mt: tap_dance_mod_tap {
compatible = "zmk,behavior-tap-dance";
label = "TAP_DANCE_MOD_TAP";
#binding-cells = <0>;
tapping-term-ms = <200>;
bindings = <&mt LSHIFT CAPSLOCK>, <&kp LCTRL>;