Kurtis Lew
28ef19488d
fix(docs): Fix Number of Profiles note in Bluetooth docs
...
Remove hard line wrapping
3 years ago
Cem Aksoylar
92e7618346
fix(docs): Fix Windows unicode macro example
3 years ago
Peter Johanson
34e1de23fb
feat(docs): Document the macro behavior.
3 years ago
Kurtis Lew
32ebe2cfb5
feat(behaviors): Add Tap-Dance behavior
3 years ago
Cem Aksoylar
5c4f26ae74
fix(docs): Tweak label of left-hand positional hold-tap example behavior
...
We see folks copying this behavior node and duplicating it for the right hand,
then forgetting to modify the "label" value and getting confusing runtime
behavior. If we modify the label to be left-specific like this it might be
a better hint to change it when duplicating it.
3 years ago
Cem Aksoylar
22ed448843
fix(docs): Replace deprecated keycode in positional-hold-tap example
3 years ago
Cem Aksoylar
76268bae8f
feat(docs): Document locality for backlight behaviors
3 years ago
Cem Aksoylar
a1ef7c8090
feat(docs): Document locality for RGB underglow behaviors
3 years ago
Cem Aksoylar
c0b5985ac7
feat(docs): Document locality for power management behaviors
3 years ago
Cem Aksoylar
5c4bf8a3bb
feat(docs): Document locality for reset behaviors
3 years ago
Alessandro Bortolin
13a4515300
feat(backlight): add command to cycle brightness
3 years ago
Alessandro Bortolin
da41391b1f
feat(docs): add backlight documentation
3 years ago
Peter Johanson
70bb7c9334
feat(behaviors): `&key_repeat` behavior + tests.
...
* Add new `&key_repeat` behavior that captures and re-sends
the most recently triggered keycode.
Closes : #853
3 years ago
Cem Aksoylar
8c321063a0
feat(docs): Add note for USB power in outputs page
3 years ago
Albert Y
a562578fd2
docs: change quick_tap_ms to quick-tap-ms ( #1071 )
3 years ago
Evan Callicoat
62e3b573b9
Typos
3 years ago
Peter Johanson
54dabffd0d
feat(behaviors): Add caps word (`&caps_word`).
...
* Add new `&caps_word` behavior that acts like caps lock, but
releases automatically when any "break" keycode is pressed.
3 years ago
jding
4e62319982
feat: hold/tap flavor tap-unless-interrupted
...
Implements new hold/tap flavor, tap-unless-interrupted
Adds tests
Adds docs
3 years ago
jmding8
19ee7849f8
feat(behaviors) Required keys for tap-hold behaviors
...
* Add optional `hold-trigger-key-positions` hold-tap configuration
* Leverage configuration for decision making around when to trigger
hold decision in hold-taps.
* Add docs for new configuration.
* Tests for the new config/decision logic.
3 years ago
Manuel Transfeld
05167c6539
fix(docs): Typo fix, open -> upon
3 years ago
Michael van Eerd
50174af658
fix(docs) add `BT_PRV` as suggested
...
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
3 years ago
Michael van Eerd
c27c1048e4
fix(docs) Bluetooth behavior typo
3 years ago
Michael van Eerd
748bc75587
fix(docs) Move Number of Profiles note down
3 years ago
Michael van Eerd
05b0353219
feat(docs) Clarify Bluetooth profile pairing
3 years ago
Nick Winans
d964faaa89
fix(docs): Standardize all internal links
3 years ago
Dom H
06a85f944f
docs(codes): Refer to LSHIFT instead of LSHFT
...
`LSHIFT` is slightly more intuitive and should result in fewer user
errors.
4 years ago
Christian Stücklberger
8196b1d46b
fix(docs): Add missing semicolon to examples
...
Co-authored-by: Christian Stücklberger <christian.stuecklberger@ergon.ch>
4 years ago
measlesbagel
3893d50e13
Docs: added mod morph page ( #749 )
...
* docs(behaviors): add mod-morph doc page
* docs(behaviors): add mod-morph doc page
* docs(mod-morph): add note about sent modifiers
* docs(mod-morph): fixed prettier formatting
4 years ago
Okke Formsma
0c1940bb79
feature(hold-tap): no-hold-flash for retro taps
...
This is an improvement on retro-tap, solving the 'flashing hold' issue
users people experience.
When the tapping-term expires, the hold key is normally pressed. When
retro-tap is enabled, this is undesirable; only an interrupted hold-tap
should trigger the hold behavior.
This change disables the hold behavior for the 'STATUS_HOLD_TIMER'
state when retro-tap is enabled, and makes sure the
'STATUS_HOLD_INTERRUPT' state will be triggered when appropriate.
4 years ago
Okke Formsma
89ed816c67
feature(hold-tap): Retro tapping
4 years ago
Okke Formsma
af9d6e9b05
style(hold-tap)!: Write hold-tap params with dashes
...
tapping_term_ms -> tapping-term-ms
quick_tap_ms -> quick-tap-ms
The old style works, although it's deprecated.
4 years ago
Pete Johanson
ae5056d680
Update docs/docs/behaviors/bluetooth.md
...
Co-authored-by: innovaker <66737976+innovaker@users.noreply.github.com>
4 years ago
Jonathan Rascher
1368a6481e
docs: Explain ZMK stays connected to inactive host
...
This behavior was not obvious to me, and I actually considered reporting
it as a bug until @Nicell explained to me on Discord that it's WAI. :)
4 years ago
Okke Formsma
9a7908b632
behaviors(hold-tap): Implement quick_tap_ms (TAPPING_FORCE_HOLD)
...
Tap-and-hold a hold-tap to hold the tap behavior so it can repeat.
After a tap, if the same key is pressed within `quick_tap_ms`, the
tap behavior is always picked.
This is useful for things like `&ht LSHFT BACKSPACE` where holding
the backspace is required.
Implements #288 .
4 years ago
Nick Winans
f39121f82e
fix(docs): Remove comment about here being four profiles for splits
4 years ago
Okke Formsma
89567d3150
docs(sticky keys): document sticky keys and sticky layers
4 years ago
Pete Johanson
e8aa576781
refactor(docs): Move combos under Features.
...
* Since combos aren't a behavior, but a new high level keymap
feature, move under Features section.
4 years ago
innovaker
13e46bea81
docs(hold-tap): mark tapping_term_ms as code
...
Improves readability and consistency.
4 years ago
Okke Formsma
feb0d5b90c
feat(combos): initial implementation
...
closes #45
4 years ago
KemoNine
af563e9dbc
Fix parameter number
4 years ago
KemoNine
79b4a0ea6f
Add RGB_COLOR_HSB to lighting documentation
4 years ago
KemoNine
d207c3c30f
(feature) Add &to keycode/behavior ( #489 )
...
feat(behaviors): Add `&to` behavior to switch to a layer.
4 years ago
Chiyuan Zhang
02673e2f1d
update doc about bluetooth
4 years ago
KemoNine
9c1a544381
Add note about default number of available profiles and how to increase if desired
4 years ago
KemoNine
52df05a545
Tweak/cleanup bluetooth documentation so it's more clear which codes should be used in keymaps as well as to call attention to BT_SEL requiring a second parameter
4 years ago
Okke Formsma
6573483a10
update errors in mod-tap docs
4 years ago
innovaker
3ebd192411
docs(key-press): remove references to `key press`
...
This was obsoleted by eff1b8223b
4 years ago
Okke Formsma
5d0532c6d9
improve hold-tap docs with better homerow example and more about flavors
4 years ago
innovaker
3e65f6d472
docs(hold-tap): Capitalize hold-tap behavior document title
...
Aligns with other documents.
4 years ago
Caleb Lightfoot
4a8a6c58fb
docs: Remove outdated HID note
...
Removed outdated HID note from key-press.md
4 years ago