6308ab9426
fix(docs): Ensure relative links always resolve
...
Linking to the document _file path_ rather than the document _URL_
ensures that the link resolves regardless of trailing slash config.
More information is at https://docusaurus.io/docs/docs-markdown-features
3 years ago
3e294375b6
feat(docs): Provide current status of Displays
3 years ago
b7b026f20c
feat(docs): Add battery sensor documentation
3 years ago
ebc6275a72
fix(docs): Document `ignore-modifiers` and `quick-release` for sticky keys ( #1228 )
3 years ago
0e54603ec6
fix(docs): Clarify backlight & underglow use cases
...
This should help reduce confusion for newcomers.
3 years ago
32c8737a22
fix(docs): Fix cmake version requirements
3 years ago
6753d31ee9
docs: Revise "Troubleshooting" for Zephyr 3.0 ( #1214 )
...
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
Co-authored-by: Dom H <dom@hxy.io>
3 years ago
9c3d909b82
feat(docs): Reference conditional layers from the layers behavior page
3 years ago
27ba5fdfb3
fix(docs): Improve powershell command for setup script for failure cases
3 years ago
3c4ff9c82c
fix(docs): Proper links to new SDK version.
3 years ago
bf2fc68070
fix(underglow): Add newly required color-mapping prop.
3 years ago
28ef19488d
fix(docs): Fix Number of Profiles note in Bluetooth docs
...
Remove hard line wrapping
3 years ago
59d2744a4f
feat(docs): Add settings_reset build instructions ( #1197 )
...
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
3 years ago
92e7618346
fix(docs): Fix Windows unicode macro example
3 years ago
5f35a0bf58
feat(docs): Add note on locating tmp file in GH actions ( #1177 )
...
Co-authored-by: Dom H <dom@hxy.io>
3 years ago
34e1de23fb
feat(docs): Document the macro behavior.
3 years ago
58c7c0ee0c
feat(docs): Add tap-dance to feature matrix
3 years ago
32ebe2cfb5
feat(behaviors): Add Tap-Dance behavior
3 years ago
594cc55e0c
fix(docs): Update instructions to find settings reset firmware
3 years ago
322cc14da6
fix(docs): Remove trailing whitespace
...
Otherwise, prettier fails.
3 years ago
43ffa6c760
docs: Clarifications within New Shield page ( #1130 )
...
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
3 years ago
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
22ed448843
fix(docs): Replace deprecated keycode in positional-hold-tap example
3 years ago
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
c18c3d9106
feat(docs): Add note for combos invoking source-specific behaviors
3 years ago
76268bae8f
feat(docs): Document locality for backlight behaviors
3 years ago
a1ef7c8090
feat(docs): Document locality for RGB underglow behaviors
3 years ago
c0b5985ac7
feat(docs): Document locality for power management behaviors
3 years ago
5c4bf8a3bb
feat(docs): Document locality for reset behaviors
3 years ago
be94e04963
docs(backlight): improve documentation
3 years ago
13a4515300
feat(backlight): add command to cycle brightness
3 years ago
2c0fe3934d
feat(backlight): add tests
3 years ago
ce843825e8
refactor(backlight): code cleanup
3 years ago
da41391b1f
feat(docs): add backlight documentation
3 years ago
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
2ad8f687c0
docs: Add a note for GitHub SSH scheme ( #1089 )
...
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
3 years ago
be343674de
docs: Fix typos and inconsistent spellings ( #1079 )
3 years ago
ef0d088cb8
feat(docs): Link to outputs page in troubleshooting re: BT output
3 years ago
8c321063a0
feat(docs): Add note for USB power in outputs page
3 years ago
3114ce00b9
docs: reiterate building from `zmk/app/` ( #1031 )
...
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
3 years ago
a562578fd2
docs: change quick_tap_ms to quick-tap-ms ( #1071 )
3 years ago
62e3b573b9
Typos
3 years ago
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
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
cbf6e28e34
docs(conditional-layers): Document feature
3 years ago
4e62319982
feat: hold/tap flavor tap-unless-interrupted
...
Implements new hold/tap flavor, tap-unless-interrupted
Adds tests
Adds docs
3 years ago
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
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
05167c6539
fix(docs): Typo fix, open -> upon
3 years ago
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
Dom H