Commit graph

517 commits

Author SHA1 Message Date
Cem Aksoylar
8c321063a0 feat(docs): Add note for USB power in outputs page 2021-12-28 21:17:48 +00:00
Ivan Smirnov
3114ce00b9
docs: reiterate building from zmk/app/ (#1031)
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2021-12-28 10:52:16 +00:00
Albert Y
a562578fd2
docs: change quick_tap_ms to quick-tap-ms (#1071) 2021-12-28 10:04:18 +00:00
Evan Callicoat
62e3b573b9 Typos 2021-12-26 13:44:46 -06:00
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.
2021-12-01 16:56:15 -05:00
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.
2021-11-28 22:41:35 -05:00
Jonathan Rascher
cbf6e28e34 docs(conditional-layers): Document feature 2021-11-15 05:49:23 -05:00
jding
4e62319982 feat: hold/tap flavor tap-unless-interrupted
Implements new hold/tap flavor, tap-unless-interrupted
Adds tests
Adds docs
2021-11-09 01:07:05 -05:00
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.
2021-11-01 12:37:20 -04:00
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.
2021-10-26 23:52:13 -04:00
dependabot[bot]
503bb0ec2f chore(deps): bump @fortawesome/react-fontawesome in /docs
Bumps [@fortawesome/react-fontawesome](https://github.com/FortAwesome/react-fontawesome) from 0.1.14 to 0.1.16.
- [Release notes](https://github.com/FortAwesome/react-fontawesome/releases)
- [Changelog](https://github.com/FortAwesome/react-fontawesome/blob/master/CHANGELOG.md)
- [Commits](https://github.com/FortAwesome/react-fontawesome/compare/0.1.14...0.1.16)

---
updated-dependencies:
- dependency-name: "@fortawesome/react-fontawesome"
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2021-10-20 22:56:45 -04:00
Manuel Transfeld
05167c6539
fix(docs): Typo fix, open -> upon 2021-10-20 22:54:48 -04:00
Peter Johanson
01d2102c23 refactor: Add js-yaml dep, scrtipt gen tweaks.
*  Make the synthetic "base name" property double underscore prefixed,
  since internal, and to avoid future conflicts w/ YAML format add'ns.
* Switch to PS hash dictionaries for our metadata collections for saner
  data inspection/use.
2021-10-16 21:50:58 -04:00
Peter Johanson
e544d74948 refactor: Config setup scripts to support onboard keyboards.
* Use unified config template repo that uses an external
  build matrix YAML file.
* Proper handling for onboard keyboards, including splits, and
 supports for appending the right build matrix once selected.
2021-10-16 21:50:58 -04:00
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.
2021-10-10 12:20:35 -07:00
Nick Winans
e6645882c3 feat(docs): Update documentation to match new Pro Micro nodes 2021-09-25 23:09:21 -04:00
Nick Winans
10870b24bf fix(docs): Update split naming system 2021-09-25 21:17:24 -04:00
Cem Aksoylar
9f2785786f fix(setup): Fix sed delimiters for Cradio 2021-09-24 15:56:36 -04:00
Richard Titmuss
5d2120ad17 fix(docs): Typo EC11_CONFIG
This should be CONFIG_EC11
2021-09-24 02:15:56 -04:00
Dom H
c52887e236 fix(docs): Remove build.yml from new shield steps 2021-09-22 17:35:08 -04:00
Dom H
8bdd270c91 fix(docs): Set "Mouse Keys" as "Under Development" 2021-09-17 10:49:56 -04:00
Michael van Eerd
50174af658 fix(docs) add BT_PRV as suggested
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2021-09-17 10:45:37 -04:00
Michael van Eerd
c27c1048e4 fix(docs) Bluetooth behavior typo 2021-09-17 10:45:37 -04:00
Michael van Eerd
748bc75587 fix(docs) Move Number of Profiles note down 2021-09-17 10:45:37 -04:00
Michael van Eerd
05b0353219 feat(docs) Clarify Bluetooth profile pairing 2021-09-17 10:45:37 -04:00
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.
2021-09-17 10:43:48 -04:00
nevin
93fbf8dd97
fix: Use correct Quotation marks on line 65 (#942) 2021-09-16 21:33:18 -04:00
Cem Aksoylar
33fa15a235
feat(docs): Add note to clarify shared .conf files do not apply outside zmk-config 2021-09-14 20:51:05 -04:00
Peter Johanson
2f0ad4cc8c fix(setup): Fix setup.ps1 to check Get-Acl exists
* `Get-Acl` not found in Linux Powershell version, so only call it
  if it exists.
2021-09-13 22:04:55 -04:00
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.
2021-09-11 00:50:36 -04:00
Peter Johanson
7d65539735 fix(docs): Deploy when boards/shields change. 2021-09-11 00:50:36 -04:00
Peter Johanson
f8e88d78c4 docs: Add docs on hardware metadata files. 2021-09-11 00:50:36 -04:00
Peter Johanson
b82bbb5ba2 feat: Generate setup scripts from metadata. 2021-09-11 00:50:36 -04:00
Peter Johanson
683991aa93 feat(docs): Type check the docs TSX components. 2021-09-11 00:50:36 -04:00
Peter Johanson
47abbe7925 feat(docs): Add dynamic hardware list component. 2021-09-11 00:50:36 -04:00
Peter Johanson
5e6634d2e5 feat(docs): Add TS type gen, metadata JSON gen
* Generate TS types from new hardware metadata schema.
* Aggregate all hw metadata YAML into one aggregate JSON
  file for consumption by others.
2021-09-11 00:50:36 -04:00
Cem Aksoylar
2a9ab828b5
fix: Add semicolons for tidbit and eek in setup script 2021-09-03 23:11:05 -04:00
chad3814
b235034dc9 fix typo
"load your newly flashed firmware" not "load your newfly flashed fireware"
2021-08-12 19:14:44 -05:00
Nick Winans
d964faaa89 fix(docs): Standardize all internal links 2021-08-12 20:07:45 -04:00
chad3814
689ba2d171
fix(docs): Fix "All" typo 2021-08-12 00:08:49 -04:00
Joel Spadin
6870fdc604 fix(docs): Appease Prettier
Fixed code formatting in docs files.
2021-08-08 13:17:27 -05:00
Peter Johanson
47109641d8 Add warning about peripheral encoders. 2021-08-04 22:25:41 -04:00
dependabot[bot]
3b9e9a7c1c chore(deps-dev): bump eslint from 7.29.0 to 7.32.0 in /docs
Bumps [eslint](https://github.com/eslint/eslint) from 7.29.0 to 7.32.0.
- [Release notes](https://github.com/eslint/eslint/releases)
- [Changelog](https://github.com/eslint/eslint/blob/master/CHANGELOG.md)
- [Commits](https://github.com/eslint/eslint/compare/v7.29.0...v7.32.0)

---
updated-dependencies:
- dependency-name: eslint
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2021-08-02 19:09:47 -04:00
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>
2021-07-27 18:18:52 -05:00
Joel Spadin
824d605c22 fix(docs): Fix keymap upgrader
Bumped web-tree-sitter to v0.19.4 and added v0.4.0 of
tree-sitter-devicetree, which had to be rebuilt to work in v0.19.x
https://github.com/joelspadin/tree-sitter-devicetree/releases/tag/v0.4.0

Changed how we patch web-tree-sitter to correctly load tree-sitter.wasm
to work with the latest version of Docusaurus. Including a copy of
tree-sitter.wasm as a static resource is no longer needed.
2021-07-24 13:12:54 -05:00
Joel Spadin
0325fe9a18 docs: Switch back to package version 2
package-lock.json was rewritten to version 1 in
13dbbefcb4.
2021-07-24 13:12:54 -05:00
Peter Johanson
861a2bf6d0 fix: Add missing semicolon for nano V2 case. 2021-07-21 22:06:32 -04:00
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
2021-07-18 03:52:45 +01:00
Peter Johanson
13dbbefcb4 chore(deps): bump @docusaurus/* to 2.0.0-beta.3 2021-07-17 22:10:36 -04:00
Peter Johanson
6217664bc3 feat(docs): Add Zephyr 2.5 blog post.
Simple blog post outlining the work done for the Zephyr 2.5 upgrade,
and steps needed to make the most of it.

Co-authored-by: innovaker <66737976+innovaker@users.noreply.github.com>
2021-07-17 17:04:25 -04:00