Cem Aksoylar
92e7618346
fix(docs): Fix Windows unicode macro example
3 years ago
Albert Y
5f35a0bf58
feat(docs): Add note on locating tmp file in GH actions ( #1177 )
...
Co-authored-by: Dom H <dom@hxy.io>
3 years ago
Peter Johanson
34e1de23fb
feat(docs): Document the macro behavior.
3 years ago
Kurtis Lew
58c7c0ee0c
feat(docs): Add tap-dance to feature matrix
3 years ago
Kurtis Lew
32ebe2cfb5
feat(behaviors): Add Tap-Dance behavior
3 years ago
Caleb Goates
594cc55e0c
fix(docs): Update instructions to find settings reset firmware
3 years ago
Dom H
322cc14da6
fix(docs): Remove trailing whitespace
...
Otherwise, prettier fails.
3 years ago
chadbailey59
43ffa6c760
docs: Clarifications within New Shield page ( #1130 )
...
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
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
Albert Y
7474d985c9
docs: Add guide to build additional keyboards with GH Actions ( #1126 )
...
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
3 years ago
Cem Aksoylar
c18c3d9106
feat(docs): Add note for combos invoking source-specific behaviors
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
be94e04963
docs(backlight): improve documentation
3 years ago
Alessandro Bortolin
13a4515300
feat(backlight): add command to cycle brightness
3 years ago
Alessandro Bortolin
2c0fe3934d
feat(backlight): add tests
3 years ago
Alessandro Bortolin
ce843825e8
refactor(backlight): code cleanup
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
Albert Y
2ad8f687c0
docs: Add a note for GitHub SSH scheme ( #1089 )
...
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
3 years ago
Evan Callicoat
be343674de
docs: Fix typos and inconsistent spellings ( #1079 )
3 years ago
Cem Aksoylar
ef0d088cb8
feat(docs): Link to outputs page in troubleshooting re: BT output
3 years ago
Cem Aksoylar
8c321063a0
feat(docs): Add note for USB power in outputs page
3 years ago
Ivan Smirnov
3114ce00b9
docs: reiterate building from `zmk/app/` ( #1031 )
...
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
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
Pete Johanson
c4ad3bc5dc
fix(docs): Make the modifier function examples clearer.
...
* Ensure the list of available modifier functions is clearly shown
as macros, not as basic defines.
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
Jonathan Rascher
cbf6e28e34
docs(conditional-layers): Document feature
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
Joel Spadin
f946dc6893
feat(kscan): Improve matrix debouncing
...
Switched the GPIO matrix driver to debouncing using a simple integrator
algorithm. Whenever a key is pressed, we now scan at a rate controlled
by debounce-scan-period-ms (default 1 ms) until all keys are released,
then return to either waiting for an interrupt or polling more slowly.
The timers for key press and release can now be controlled separately,
so debounce-period is deprecated in favor of debounce-press-ms and
debounce-release-ms. Global Kconfig options
ZMK_KSCAN_DEBOUNCE_PRESS_MS and ZMK_KSCAN_DEBOUNCE_RELEASE_MS are also
added to make these easier to set.
Added documentation for debouncing options.
3 years ago
Manuel Transfeld
05167c6539
fix(docs): Typo fix, open -> upon
3 years ago
Jonathan Rascher
96fea949d5
docs(docs): Document up-to-date Node.js repo
...
For example, Debian Bullseye (current stable) packages Node.js version
12, which is too old to build the docs successfully. At least version 14
is required, and version 16 is current. General advice seems to be to
install from the NodeSource repo instead of your distro's repo, so I
added a suggestion to the docs.
3 years ago
Nick Winans
e6645882c3
feat(docs): Update documentation to match new Pro Micro nodes
3 years ago
Nick Winans
10870b24bf
fix(docs): Update split naming system
3 years ago
Richard Titmuss
5d2120ad17
fix(docs): Typo EC11_CONFIG
...
This should be CONFIG_EC11
3 years ago
Dom H
c52887e236
fix(docs): Remove build.yml from new shield steps
3 years ago
Dom H
8bdd270c91
fix(docs): Set "Mouse Keys" as "Under Development"
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
Richard Titmuss
d769618b3f
fix(docs): Remove unnecessary security warning for MacOS
...
The security warning applies for downloaded executables. If you are
following the instructions the toolchain is installed with brew and
the security warning does not apply. This is explained in the removed
link.
3 years ago
Cem Aksoylar
33fa15a235
feat(docs): Add note to clarify shared .conf files do not apply outside zmk-config
3 years ago
Peter Johanson
7bf68f2a00
refactor(docs): Remove build.yml for new shield.
...
* No longer recommending that all new shields get added to the
build matrix in `build.yml`, so we avoid conflicts.
3 years ago
Peter Johanson
f8e88d78c4
docs: Add docs on hardware metadata files.
3 years ago