Joel Spadin
65667b863a
docs: Add syntax highlighting to more code blocks
...
Added language tags to more code blocks in the documentation to enable
syntax highlighting.
2023-10-09 15:19:24 -07:00
Amettler Thierry
913fdb831e
feat(docs): Add configuration snippet for layer-taps
2023-10-04 13:29:06 -07:00
Andrew Rae
11996ff7f0
refactor(behaviors): Final global-quick-tap deprecation.
2023-10-03 01:12:47 -07:00
Andrew Rae
2234be0871
refactor(docs): Apply suggestions from @caksoylar
...
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com >
2023-10-03 01:12:47 -07:00
Andrew Rae
b85ffa4b6c
refactor(behaviors): global-quick-tap -> require-prior-idle
...
Renaming global-quick-tap-ms to require-prior-idle.
2023-10-03 01:12:47 -07:00
Andrew Rae
49c393e8f8
refactor(docs): Applying suggestions for gqt from @caksoylar
...
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com >
2023-10-03 01:12:47 -07:00
Andrew Rae
1e84e265b1
feat(docs): Adding global-quick-tap-ms docs
2023-10-03 01:12:47 -07:00
Nate Eagleson
693875675f
fix(docs): Fix typo in caps-word.md ( #1924 )
2023-09-04 16:59:59 -07:00
Cem Aksoylar
4e18b879bd
feat(docs): Document persisted settings and debouncing
2023-09-02 23:02:17 -07:00
Cem Aksoylar
b20d3178b9
feat(docs): Note devicetree limits re: macro bindings
2023-09-02 22:59:17 -07:00
Cem Aksoylar
369c7c1721
fix(docs): Correct default macro wait/tap ms
2023-09-02 22:59:17 -07:00
Jorge Villalobos
d17c473d45
feat(docs): Improve parameterized macros docs
2023-08-02 09:57:00 -07:00
Maciej Konieczny aka narf
cec2061dad
fix(docs): Fix typos in parameterized macros docs.
2023-07-19 15:42:35 -07:00
Peter Johanson
805dd4a53b
feat(behaviors): Support parameterized macros.
...
* Add two new compatibles for macros that
take one or two parameters when bound in
a keymap.
* Use `¯o_param_1to1`, `¯o_param_1to2`, `¯o_param_2to1`,
and `¯o_param_2to2` control entries in the bindings for the macro
to have the next binding entry have it's values substituted.
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com >
2023-06-20 11:19:28 -06:00
Cem Aksoylar
0508718d6c
feat(docs): Add behavior types section for hold-tap
2023-06-02 21:11:33 -06:00
Cem Aksoylar
a2af74f5ab
feat(docs): Add note on modifier functions to macros
2023-06-02 21:08:02 -06:00
Joel Spadin
94061bb916
refactor: Replace tabs with spaces
...
Standardized indentation to use spaces with a new pre-commit hook.
2023-04-24 16:07:04 -07:00
Albert Y
9c4f1e02d1
fix(docs): Update references to QMK settings
...
* Remove TAPPING_FORCE_HOLD reference
* Remove IGNORE_MOD_TAP_INTERRUPT reference
2023-04-24 04:24:36 -04:00
Nick Coutsos
9d64c2a3a0
fix(docs): switch sensor rotate parameter order
2023-04-22 17:30:10 -07:00
Nick Conway
3db163aa2c
feat(behaviors): Add reusable sensor behaviors.
...
* Add new sensor behaviors that either take full bindings
add definition, or accept parameters when bound in the
keymap.
* Remove existing hard-coded key press sensor behavior
and instead leverage new generic sensor behaviors to
achieve the same functionality.
Co-authored-by: nick@conway.dev
2023-04-21 21:13:31 -07:00
Josep Roca
71855af14f
fix(docs): ignore-modifiers clarification
...
* Clarify the potential need of adding the ignore-modifiers setting for new sticky key behaviors.
* Add ignore-modifiers setting to skq example
* Update docs/docs/behaviors/sticky-key.md
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com >
2023-04-16 03:04:49 -04:00
Peter Johanson
35a1c5a3d4
refactor(behaviors): Rename reset behavior.
...
* Upstream now has a node w/ label `reset` on many boards, so
renaming our reset behavior node label to `sys_reset`.
2023-04-05 22:55:38 -07:00
Robert U
6cb42a8060
feat(behaviors): On-release option for positional-hold-taps
2023-03-12 12:24:00 -04:00
Petrus Claviger
408b87ae7b
fix(docs): Grammatical fixes ( #1587 )
...
Co-authored-by: Dom H <dom@hxy.io >
2022-12-14 14:51:46 +00:00
Nick Coutsos
5cd608cb60
fix(docs): Correct syntax in capsword mods
2022-11-24 19:11:24 -06:00
Robert U
ef2e6e9156
feat(behaviors): Add mod-morph keep-mods
...
* Update docs for mod-morph
* Add unit tests for mod-morph
* Add keep-mods to DT binding
Co-authored-by: Martin Aumüller <aumuell@reserv.at >
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com >
2022-10-14 20:40:28 -05:00
Kurtis Lew
8976b353ae
fix(docs): Correct mo_tog implementation in tabbed menu
2022-09-25 20:06:20 -05:00
David A. Bell
8f67333957
Update docs/docs/behaviors/hold-tap.md
...
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com >
2022-09-21 23:44:09 -05:00
David A. Bell
9756a16306
fix(docs): Consistent naming in Mo-Tog example.
...
Updated all references in example to conform to Hold action-Tap action wording order.
2022-09-21 23:44:09 -05:00
David A. Bell
597a48ff2d
Update hold-tap.md
...
The bindings for the toggle-layer-on-tap/momentary-layer-on-hold example code were backwards, resulting in toggle-on-hold. This also made momentary unachievable.
2022-09-21 23:44:09 -05:00
Robert U
3f28a55452
fix(docs): Fix ambiguous tap-preferred desc.
2022-09-11 21:06:04 -04:00
Kurtis Lew
eee7e1cd41
fix(docs): Update tap-dance and hold-tap documentation
...
Co-Authored-By: Cem Aksoylar <caksoylar@users.noreply.github.com >
2022-07-30 10:24:49 +01:00
Nick Coutsos
70beff7e62
refactor(docs): Change wording in RGB_COLOR_HSB description
...
Simplify description for second &rgb_ug parameter
2022-07-27 08:15:46 -04:00
GreenAirplane
f68692effd
feat(docs): Document behavior queue limit for Macros ( #1384 )
...
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com >
Co-authored-by: Dom H <dom@hxy.io >
2022-07-20 16:17:19 +01:00
Joel Spadin
bf84481b47
feat(docs): Update behavior config docs
2022-07-03 18:55:54 +01:00
Cem Aksoylar
91de215bf0
fix(docs): Add missing underglow on/off defines
2022-07-03 13:30:25 +01:00
Kurtis Lew
edc60e5848
fix(docs): Update keycode usage ID for numeric 4 in key-press.md
...
Co-Authored-By: Robert U <978080+urob@users.noreply.github.com >
2022-06-20 23:27:57 -04:00
Peter Johanson
1e8224c296
feat(behaviors): Add DEL/BSPC to continue list.
...
* Continue caps word on delete/backspace by
default now.
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com >
2022-06-04 01:38:42 -04:00
Caleb Goates
0977be622a
feat(docs): Add docs for key toggle behavior
2022-06-03 00:04:41 -04:00
Andrew Rae
b5efc7a7eb
feat(behaviors): Add global-quick-tap
2022-04-27 13:33:22 +01:00
Xudong Zheng
dffae5cf2b
fix(docs): Correct default Mod-Tap behavior
2022-04-26 18:49:15 +01:00
Herald
ebc6275a72
fix(docs): Document ignore-modifiers and quick-release for sticky keys ( #1228 )
2022-04-14 16:13:33 +01:00
Albert Y
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 >
2022-04-07 09:26:22 +01:00
Caleb Goates
9c3d909b82
feat(docs): Reference conditional layers from the layers behavior page
2022-04-06 19:11:23 +01:00
Kurtis Lew
28ef19488d
fix(docs): Fix Number of Profiles note in Bluetooth docs
...
Remove hard line wrapping
2022-03-31 09:00:47 +01:00
Cem Aksoylar
92e7618346
fix(docs): Fix Windows unicode macro example
2022-03-28 21:16:48 -04:00
Peter Johanson
34e1de23fb
feat(docs): Document the macro behavior.
2022-03-23 23:42:54 -04:00
Kurtis Lew
32ebe2cfb5
feat(behaviors): Add Tap-Dance behavior
2022-03-16 01:08:42 -04:00
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.
2022-02-12 07:09:58 +00:00
Cem Aksoylar
22ed448843
fix(docs): Replace deprecated keycode in positional-hold-tap example
2022-02-12 07:09:58 +00:00
