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
Peter Johanson
47abbe7925
feat(docs): Add dynamic hardware list component.
3 years ago
chad3814
b235034dc9
fix typo
...
"load your newly flashed firmware" not "load your newfly flashed fireware"
3 years ago
Nick Winans
d964faaa89
fix(docs): Standardize all internal links
3 years ago
chad3814
689ba2d171
fix(docs): Fix "All" typo
3 years ago
Joel Spadin
6870fdc604
fix(docs): Appease Prettier
...
Fixed code formatting in docs files.
3 years ago
Peter Johanson
47109641d8
Add warning about peripheral encoders.
3 years ago
Felix Sargent
6d105f324b
Update docs to use “SQT” instead of “QUOTE” ( #839 )
...
* Update default keymap to use SQT
Instead of the invalid “QUOTE”
* Update keymap-example-file.md
* Update docs/docs/keymap-example.md
Co-authored-by: Pete Johanson <peter@peterjohanson.com>
Co-authored-by: Pete Johanson <peter@peterjohanson.com>
3 years ago
innovaker
a8c0c76fca
docs(setup): replace `zephyr-west-action` with `zmk-docker`
...
This should've been changed after #481 .
See: https://github.com/zmkfirmware/zmk/pull/481
PR: https://github.com/zmkfirmware/zmk/pull/845
3 years ago
innovaker
47043c86e9
docs: bump Zephyr documentation links to Zephyr v2.5.0
...
PR: https://github.com/zmkfirmware/zmk/pull/736
3 years ago
innovaker
c03046e54a
docs(setup): add `x86_64-linux` to Zephyr SDK setup filename
...
See: zmkfirmware/zmk-docker@b8341e185ab694f7c596b81d03ada34ac76d2f1c
PR: https://github.com/zmkfirmware/zmk/pull/736
3 years ago
innovaker
76979d293a
docs(setup): bump `ZSDK_VERSION` to `0.12.4`
...
PR: https://github.com/zmkfirmware/zmk/pull/736
3 years ago
Nick Winans
9c1319c4ff
feat(docs): Add nice!nano v2 to scripts, actions, and documentation
...
asdf
asdf
asdf
3 years ago
innovaker
576ce76ad3
docs(setup): fix whitespace in Fedora toolchain install command
...
Aligns Fedora whitespace with Debian.
3 years ago
innovaker
84a5fec458
docs(setup): remove extra slash from Fedora toolchain install command
3 years ago
innovaker
6f3a2529ae
docs(setup): fix whitespace mismatch in host dependencies
...
Replaces spaces with tabs (bzip2).
3 years ago
Peter Johanson
3f4839ec96
refactor: Move to new zmk.dev domain name.
3 years ago
Peter Johanson
ba45aaa81b
chore(docs): Bump prettier, and reformat w/ it.
...
* Bump to prettier 2.3.1.
* Re-run prettier:format to apply updated format.
3 years ago
Peter Johanson
7323f78a37
fix(docs): Upgrade docusaurus, webpack/loaders.
...
Upgrade to the new Docusaurus 2 beta release, which also required
upgrades to newer Webpack@5, and some API fixes for TOC changes.
3 years ago
Martin Eberhardt
87ee2304a1
feat(docs): Add icon legend to the feature matrix
...
Add icon legend to the feature matrix
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.
3 years ago
Ivan Smirnov
bb32005474
fix(docs): Update macos GCC embedded section with brew cmd
...
* Update macos GCC embedded section with brew cmd
Brew has a cask for GCC embedded, so we can make this guide more user friendly by providing it.
3 years ago