Commit Graph

881 Commits

Author SHA1 Message Date
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 `&macro_param_1to1`, `&macro_param_1to2`, `&macro_param_2to1`,
  and `&macro_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
Peter Johanson
5763558a02 feat(blog): Add post about sensor refactor.
* Document changed configuration, support for other Zephyr
  drivers, next steps.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2023-06-18 20:45:06 -06:00
dependabot[bot]
9d714c0b69 chore(deps-dev): bump webpack from 5.80.0 to 5.86.0 in /docs
Bumps [webpack](https://github.com/webpack/webpack) from 5.80.0 to 5.86.0.
- [Release notes](https://github.com/webpack/webpack/releases)
- [Commits](https://github.com/webpack/webpack/compare/v5.80.0...v5.86.0)

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

Signed-off-by: dependabot[bot] <support@github.com>
2023-06-10 23:51:23 -07:00
dependabot[bot]
0be0d07630 chore(deps): bump minimatch and serve-handler in /docs
Bumps [minimatch](https://github.com/isaacs/minimatch) and [serve-handler](https://github.com/zeit/serve-handler). These dependencies needed to be updated together.

Updates `minimatch` from 3.0.4 to 3.1.2
- [Release notes](https://github.com/isaacs/minimatch/releases)
- [Commits](https://github.com/isaacs/minimatch/compare/v3.0.4...v3.1.2)

Updates `serve-handler` from 6.1.3 to 6.1.5
- [Release notes](https://github.com/zeit/serve-handler/releases)
- [Commits](https://github.com/zeit/serve-handler/compare/6.1.3...6.1.5)

---
updated-dependencies:
- dependency-name: minimatch
  dependency-type: indirect
- dependency-name: serve-handler
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-06-10 23:37:26 -07:00
pixls
9d39a87f67
fix(docs): Change user-setup.md order to agree with order in setup script
Fixes #1281 

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2023-06-10 17:49:30 -07:00
kadoyau
98524a9567
fix(docs): Fix INT6 keycode description 2023-06-10 12:32:50 -07:00
Albert Y
a5c57fa224
feat(docs): Add an example for combining just modifiers (#1826)
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2023-06-05 22:22:39 -07:00
Peter Johanson
19d883cdfe fix(bluetooth): Passkey pairing improvements.
* Capture the last 6 entered digits, and then require pressing
   Enter/Return to submit the entered digits. This matches the
   messaging shown on hosts regarding how to complete pairing.
* Fix the wording on the Kconfig menu item to accurately describe
  the feature.
2023-06-05 00:01:44 -06:00
Cem Aksoylar
ace11e327f fix(docs): Fix broken link in BT troubleshooting 2023-06-02 22:07:29 -06:00
Cem Aksoylar
0682bc3aa6 feat(docs): Note split connectivity improvement with TX power 2023-06-02 21:13:27 -06:00
Cem Aksoylar
a9ad11f91e refactor(docs): Move BT troubleshooting items to BT page 2023-06-02 21:13:27 -06:00
Cem Aksoylar
30ba4b08ae feat(docs): Add pointer to Bluetooth page in troubleshooting 2023-06-02 21:13:27 -06:00
Cem Aksoylar
4042aea66f feat(docs): Add troubleshooting for Windows issue 2023-06-02 21:13:27 -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
Xudong Zheng
1adfcf92bf refactor(split): fix inconsistency in Kconfig names 2023-05-28 22:58:31 -06:00
Cem Aksoylar
864394b40a feat(display): Add setting to invert display colors
Add CONFIG_ZMK_DISPLAY_INVERT Kconfig to invert colors
(black-on-white to white-on-black) on monochrome screens.
Currently applies only if CONFIG_LV_USE_THEME_MONO is selected,
which is the default unless user overrides it.
2023-05-21 21:51:36 -06:00
Joel Spadin
c4c014e3d1 fix(docs): Fix typescript error
See https://github.com/facebook/docusaurus/issues/8226#issuecomment-1420620198
2023-05-20 01:33:11 -06:00
Joel Spadin
dae020787e docs: Update tree-sitter
Updated web-tree-sitter and the devicetree grammar.

web-tree-sitter now supports a custom function to locate its .wasm file,
so performing a string replace is no longer necessary to get it to work
with Docusaurus' Webpack configuration. We now check when tree-sitter is
locating its .wasm file and provide the Webpack-adjusted URL.
2023-05-20 01:33:11 -06:00
Joel Spadin
c6bf95a901 chore: Update fontawesome 2023-05-20 01:33:11 -06:00
Joel Spadin
da2599aa75 chore: Update docusaurus, react types 2023-05-20 01:33:11 -06:00
Joel Spadin
4674215551 chore: Update json-schema-to-typescript 2023-05-20 01:33:11 -06:00
Joel Spadin
d799560985 chore: Update typescript, eslint, webpack 2023-05-20 01:33:11 -06:00
Albert Y
48be2eedd0 fix(docs): Update QMK debounce references 2023-05-09 21:40:14 -07:00
Joel Spadin
9bd171ede4 fix(docs): Add key to interconnect tabs
Added a key property to interconnect tabs list items to fix a React
warning.
2023-04-25 15:50:38 -07:00
Joel Spadin
7a352908ee docs: Add pre-commit documentation 2023-04-24 16:07:04 -07:00
Joel Spadin
5b07c86d05 chore: Update Prettier
Added a workaround to select the latest version of Prettier with
pre-commit, since the pre-commit mirror repo started tracking alpha
releases and doesn't have anything beyond 2.7.1.
2023-04-24 16:07:04 -07: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
Joel Spadin
32ae776c42 refactor: Add more checks to pre-commit
Updated existing pre-commit hooks and added some new hooks:

- Remove trailing whitespace
- Ensure every non-empty file ends with a new line
- Check YAML file validity
- Prevent adding large files
- Ensure any scripts with shebangs are executable

Added a GitHub action to run pre-commit on every commit. Removed any
existing actions which duplicate pre-commit.

Ran pre-commit on the codebase.
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
sporkus
83a151890c
fix(docs): Correct example keymap filename 2023-04-16 13:28:08 -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
374104dec6 fix(underglow): Move to spi3 for underglow bus.
* Workaround Zephyr bug for Nordic SPI(M) driver after the
  pinctrl refactor by using spi3 peripheral for the SPI bus for
  the WS2812 led_strip driver.
2023-04-09 14:41:00 -07:00
Peter Johanson
134b64ef5b fix(docs): Make link to keymap upgrader work. 2023-04-05 23:18:34 -07:00
Peter Johanson
2614b85634 feat(docs): Add blog post for Zephyr 3.2.
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2023-04-05 22:55:38 -07:00
Peter Johanson
0c5bcf5fe4 feat(docs): Add BLE feature/config pages.
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2023-04-05 22:55:38 -07:00
Peter Johanson
1493620bf7 refactor(boards): Move to pinctrl. 2023-04-05 22:55:38 -07:00
Peter Johanson
09ed79a867 refactor: Move away from deprecated label usages.
* Move away from DT_LABEL.
* Move to DEVICE_DT_GET for non-behavior device access.
* Move various drivers to `gpio_spec_dt` and `DT` related macros.
* Remove mcp23017 while at it, since better upstream driver is
  available.
2023-04-05 22:55:38 -07:00
Peter Johanson
3a958c667f refactor: Move to zephyr/ include paths.
* Zephyr moved to properly namespaced headers, so major "rip
  the bandaid" commit to move us to those everywhere.
2023-04-05 22:55:38 -07: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
dependabot[bot]
5ef6f2f2b7 chore(deps): bump http-cache-semantics from 4.1.0 to 4.1.1 in /docs
Bumps [http-cache-semantics](https://github.com/kornelski/http-cache-semantics) from 4.1.0 to 4.1.1.
- [Release notes](https://github.com/kornelski/http-cache-semantics/releases)
- [Commits](https://github.com/kornelski/http-cache-semantics/compare/v4.1.0...v4.1.1)

---
updated-dependencies:
- dependency-name: http-cache-semantics
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-02-25 01:27:37 -05:00
dependabot[bot]
719de801e7 chore(deps): bump @sideway/formula from 3.0.0 to 3.0.1 in /docs
Bumps [@sideway/formula](https://github.com/sideway/formula) from 3.0.0 to 3.0.1.
- [Release notes](https://github.com/sideway/formula/releases)
- [Commits](https://github.com/sideway/formula/compare/v3.0.0...v3.0.1)

---
updated-dependencies:
- dependency-name: "@sideway/formula"
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-02-25 00:57:00 -05:00
Albert Y
b7d5865e40 feat(docs): additional note on bug fixed in macOS v13.1 2023-02-02 21:23:48 -05:00
dependabot[bot]
2a5e914a77 chore(deps): bump json5 from 2.2.1 to 2.2.3 in /docs
Bumps [json5](https://github.com/json5/json5) from 2.2.1 to 2.2.3.
- [Release notes](https://github.com/json5/json5/releases)
- [Changelog](https://github.com/json5/json5/blob/main/CHANGELOG.md)
- [Commits](https://github.com/json5/json5/compare/v2.2.1...v2.2.3)

---
updated-dependencies:
- dependency-name: json5
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-01-26 19:35:16 -05:00
Joel Spadin
82ff6d8e85 docs: update dev env setup guide
Renamed the "Basic Setup" page to "Toolchain Setup" to make it clearer
that this is for setting up a development environment for local builds.

Linked to the relevant Zephyr setup documentation instead of duplicating
that information in our guide. This also switches Windows and macOS
setup to using the Zephyr SDK, which is much easier to install.

Updated the command for installing Zephyr's Python dependencies to be
OS specific, as Windows and macOS don't need the --user flag.

Updated the IDE integration page with instructions for determining the
compiler path that work with the latest version of the Zephyr SDK.
2023-01-19 22:25:10 -05:00
Peter Johanson
c23443a086 feat(docs): Generate new shield interconnect docs.
* Add to metadata schema for interconnects.
* New conventional location for pinout diagrams/pics.
* New component to generate the tabs for the new shield
  doc section on interconnects.
* Add XIAO and arduino uno pinout diagram.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2022-12-23 02:41:35 -06:00
Cem Aksoylar
d993b03433 feat(docs): Refer to troubleshooting in connecting split halves 2022-12-23 00:20:12 -06:00
Cem Aksoylar
080c47825f feat(docs): Add caution note about split peripheral sides to user setup 2022-12-23 00:20:12 -06:00
Cem Aksoylar
77d60182bf feat(docs): Recommend USB testing and warn about BT pairing in user setup 2022-12-23 00:20:12 -06:00
Joel Spadin
3eb06f137b feat: Add global macro timing configs
Added ZMK_MACRO_DEFAULT_WAIT_MS and ZMK_MACRO_DEFAULT_TAP_MS to set
global defaults for the wait-ms and tap-ms properties of macros.

Also reduced the default timings for macros, since it's been reported
many times that 100 ms is too slow.
2022-12-20 20:34:25 -06:00
as29
11ca0098a5
fix(docs): Disable encoders in dtsi (#1600) 2022-12-20 20:24:32 +00:00
Cem Aksoylar
781df31ec4 fix(setup): Fix conf download path in PS script 2022-12-17 17:46:22 -06:00
Cem Aksoylar
b8fb218a01 fix(setup): Make keymap/conf fall back to using dirname 2022-12-16 17:41:39 -06: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
Peter Johanson
f03e29ca13 fix(config): Fix split wired detection in setup.sh. 2022-12-11 09:29:58 -06:00
Kyle McCreery
70aa4fa824
feat(boards): Add PillBug board, blackpill interconnect.
* Add blackbill interconnect metadata.
* Add config/overlay for upstream blackpill boards to work with ZMK.
* Add pillbug board.
* Updated new shield docs.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2022-12-10 22:01:37 -06:00
Cem Aksoylar
2a42fe658e feat(docs): Document battery widget percentage Kconfig 2022-12-10 17:08:37 -06:00
Joel Spadin
6ccb5280c9 fix(docs): Pin Zephyr docs links to a version
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2022-12-08 01:00:48 -06:00
Joel Spadin
593db85378 feat(boards): Add support for nRF5340 DK
Added overlays to support building for the nRF5340 development kit.

Also added some documentation on how to build and flash ZMK for dual-
chip Bluetooth configurations, with an example for the nRF5340.
2022-12-08 01:00:48 -06:00
Kurtis Lew
001105e318 fix(docs): Correct typo in hold-tap comparison balanced flavor 2022-12-01 20:11:31 +00:00
dependabot[bot]
4d0e0fa34b chore(deps): bump loader-utils from 2.0.3 to 2.0.4 in /docs
Bumps [loader-utils](https://github.com/webpack/loader-utils) from 2.0.3 to 2.0.4.
- [Release notes](https://github.com/webpack/loader-utils/releases)
- [Changelog](https://github.com/webpack/loader-utils/blob/v2.0.4/CHANGELOG.md)
- [Commits](https://github.com/webpack/loader-utils/compare/v2.0.3...v2.0.4)

---
updated-dependencies:
- dependency-name: loader-utils
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-11-25 21:00:42 -06:00
Nick Coutsos
5cd608cb60 fix(docs): Correct syntax in capsword mods 2022-11-24 19:11:24 -06:00
Michael Anthony
6e7c2a08a2
fix(docs): Update link to Zephyr led docs
* Change Zephyr gpio-leds link to 3.0.0
2022-11-14 16:58:28 -06:00
byran.tech
c7d83fb951
fix(docs): changed MacOS to macOS as per Apple styling 2022-11-09 20:38:08 -06:00
Terence Stenvold
9847a4c5d5
fix(docs): copy error not exclusive to Apple silicon 2022-11-09 14:56:22 -06:00
Albert Y
4e11913127
feat(docs): troubleshooting steps for macOS 13 Finder bug 2022-10-27 21:03:16 -05:00
Peter Johanson
3353712bc1 fix(docs): npm start to work from Docker.
* Listen on 0.0.0.0 so testing docs within our container works
  properly with port forwarding.
2022-10-26 23:02:54 -05:00
Peter Johanson
a02eb28271 fix(docs): Move to data-tooltip for profiler.
* Fix ESLint warning by using `data-` prefixed custom attr.
2022-10-26 23:02:54 -05:00
Peter Johanson
2d7c8f6073 chore(docs): Bump docusaurus and run audit fix. 2022-10-26 23:02:54 -05:00
ebastler
c9eb63199a
feat(keymaps): add NUHS/NUBS alias for Non-US-Backslash/Non-US-Hash 2022-10-17 21:48:19 -04:00
byran.tech
3f00f14e36
feat(docs): Added a Spelling Error Caution Notice 2022-10-15 14:00:09 -05: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
Nick Winans
bdc706f88d
docs(power profiling): add nice!view 2022-10-07 20:43:12 -04:00
Joe Peterson
a035fe4cc8 docs(codes): Windows Support: F20-F24
F20-24 are confirmed to work on Windows 11 via a web based keyboard
tester

Refs: #1476
2022-10-05 09:01:37 -04:00
Joe Peterson
fd5e9e1403 docs(codes): Windows Support: F13-F19
F13-F19 are confirmed to work on Windows 11 in VSCode 1.71.2.

Refs: #1476
2022-10-05 09:01:37 -04:00
Nick Winans
3d3c45bc80
feature(shields): Add nice!view
* Use two shield system, nice_view, and nice_view_adapter
* Build system fixes for interconnect use.
2022-09-29 21:11:26 -04:00
Peter Johanson
30e9accc95 feat(docs): Wait options for matrix driver.
* Document `CONFIG_ZMK_KSCAN_MATRIX_WAIT_BETWEEN_OUTPUTS` and
  `CONFIG_ZMK_KSCAN_MATRIX_WAIT_BEFORE_INPUTS` options
2022-09-29 01:06:54 -04:00
dependabot[bot]
fad8dd6612 chore(deps): bump terser from 5.9.0 to 5.14.2 in /docs
Bumps [terser](https://github.com/terser/terser) from 5.9.0 to 5.14.2.
- [Release notes](https://github.com/terser/terser/releases)
- [Changelog](https://github.com/terser/terser/blob/master/CHANGELOG.md)
- [Commits](https://github.com/terser/terser/commits)

---
updated-dependencies:
- dependency-name: terser
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-09-25 23:47:15 -04: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
Shreyas
391f80f069
feat(hid): Add C_AC_DESKTOP_SHOW_ALL_APPLICATIONS
* support for C_AC_DESKTOP_SHOW_ALL_APPLICATIONS

Co-authored-by: Shreyas Kale <shreyaskale@Shreyass-MacBook-Pro.local>
2022-08-22 00:27:47 -04:00
byran.tech
b21ddcf79a
fix(docs): added concrete number for Bluetooth advertising name length
* Update new-shield.md
* Update config docs.
2022-08-19 10:29:12 -04:00
Anton
f238001904
doc(keymaps): fix typo (#1425) 2022-08-12 07:37:06 -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
byran.tech
8bc96ab9fe
feat(docs): added "how is the latency"
* Update docs/docs/faq.md

Co-authored-by: Kurtis Lew <kurtis.a.lew@gmail.com>
Co-authored-by: Dom H <dom@hxy.io>
Co-authored-by: Pete Johanson <peter@peterjohanson.com>
2022-07-27 09:07:57 -04:00
HanfG
01f51f06dc
fix(docs): Fix col/row properties in kscan.md example 2022-07-27 08:17:40 -04: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
byran.tech
54aa3e6a1e
fix(docs): typo fixes
* Update user-setup.md
2022-07-25 23:43:56 -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
byran.tech
b1ce8a0d33
fix(docs): typo fixes 2022-07-12 08:47:19 +01:00
Cem Aksoylar
41c9d81096 fix(docs): Update config docs for split Kconfig refactor 2022-07-05 08:42:27 +01:00
Cem Aksoylar
19d8c5ba40 feat(docs): Document new underglow Kconfig 2022-07-05 08:42:27 +01:00
Cem Aksoylar
851c37e14f fix(docs): Apply suggestions from #722 reviews 2022-07-05 08:42:27 +01:00
Joel Spadin
ae78aa247a feat(docs): Update power and lighting config pages
Moved battery configuration to its own page to match the feature page.

Documented that external power is disabled when in sleep mode.

Clarified that the *_START configs apply on first boot, and any changes
after that are persisted.
2022-07-03 18:55:54 +01:00
Joel Spadin
1646cd7f30 feat(docs): Add a simpler matrix transform example 2022-07-03 18:55:54 +01:00
Joel Spadin
6e67e4a3a5 feat(docs): Update direct GPIO configuration 2022-07-03 18:55:54 +01:00
Joel Spadin
74b4933980 feat(docs): Clarify descriptions of config files 2022-07-03 18:55:54 +01:00
Joel Spadin
e0e0928f9c fix(docs): Update config docs for review feedback 2022-07-03 18:55:54 +01:00
Joel Spadin
01ffea1b47 feat(docs): Update configuration overview 2022-07-03 18:55:54 +01:00
Joel Spadin
c350f7130b fix(docs): Fix links in config pages 2022-07-03 18:55:54 +01:00
Joel Spadin
2b122acfc3 feat(docs): Updating lighting config docs 2022-07-03 18:55:54 +01:00
Joel Spadin
e8e6b2a333 feat(docs): Update general system config docs 2022-07-03 18:55:54 +01:00
Joel Spadin
e46eaf5617 feat(docs): Update power config docs 2022-07-03 18:55:54 +01:00
Joel Spadin
71b8f9d4ac feat(docs): Update display config docs 2022-07-03 18:55:54 +01:00
Joel Spadin
bf84481b47 feat(docs): Update behavior config docs 2022-07-03 18:55:54 +01:00
Joel Spadin
d36792db2d feat(docs): Update kscan config docs 2022-07-03 18:55:54 +01:00
Joel Spadin
11861a4d30 docs: Add documentation for config options 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
a7e857f7e1 fix(docs): Fix acorn dep in package lock file.
* Use npm version matching Netlify to fix up our lock file.
2022-06-06 11:05:47 -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
Peter Johanson
8e67524e62 chore: Bump docusaurus and fix deps issue. 2022-06-03 00:35:07 -04:00
Caleb Goates
0977be622a feat(docs): Add docs for key toggle behavior 2022-06-03 00:04:41 -04:00
Yomi Ikuru
6150ad65c4
feat(docs): Add tip for improving build times 2022-05-31 21:32:13 +01:00
Peter Johanson
6539b3ae25 refactor(split): Clean up Kconfig organization.
* Seperated configs for split role (central/peripheral)
  and transport (BLE only for now).
* Split the configs to align on structure.
2022-05-29 19:18:09 -04:00
Dom H
c679b7e07d fix(docs): Standardize URLs with no trailing slash
Previously, a trailing slash would be appended to all URLs when accessed
directly, but not when accessed via menus and links.

This Docusaurus configuration option keeps the URLs consistent by never
appending a trailing slash.

https://docusaurus.io/docs/api/docusaurus-config#trailing-slash
2022-05-23 10:09:53 -04:00
dependabot[bot]
c11e2caf77 chore(deps-dev): bump eslint-plugin-react from 7.28.0 to 7.30.0 in /docs
Bumps [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) from 7.28.0 to 7.30.0.
- [Release notes](https://github.com/jsx-eslint/eslint-plugin-react/releases)
- [Changelog](https://github.com/jsx-eslint/eslint-plugin-react/blob/master/CHANGELOG.md)
- [Commits](https://github.com/jsx-eslint/eslint-plugin-react/compare/v7.28.0...v7.30.0)

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

Signed-off-by: dependabot[bot] <support@github.com>
2022-05-23 10:07:26 -04:00
dependabot[bot]
22a7a98070 chore(deps-dev): bump string-replace-loader from 3.0.3 to 3.1.0 in /docs
Bumps [string-replace-loader](https://github.com/Va1/string-replace-loader) from 3.0.3 to 3.1.0.
- [Release notes](https://github.com/Va1/string-replace-loader/releases)
- [Commits](https://github.com/Va1/string-replace-loader/compare/v3.0.3...v3.1.0)

---
updated-dependencies:
- dependency-name: string-replace-loader
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-05-23 00:25:55 -04:00
Kurtis Lew
8a70d5fccc
feat(docs): Add New Behavior Guide
Co-authored-by: Henré Botha <henrebotha@gmail.com>
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
Co-authored-by: Dom H <dom@hxy.io>
Co-authored-by: Pete Johanson <peter@peterjohanson.com>
2022-05-21 17:26:10 +01:00
dependabot[bot]
90f3107c49 chore(deps-dev): bump @tsconfig/docusaurus from 1.0.2 to 1.0.5 in /docs
Bumps [@tsconfig/docusaurus](https://github.com/tsconfig/bases/tree/HEAD/bases) from 1.0.2 to 1.0.5.
- [Release notes](https://github.com/tsconfig/bases/releases)
- [Commits](https://github.com/tsconfig/bases/commits/HEAD/bases)

---
updated-dependencies:
- dependency-name: "@tsconfig/docusaurus"
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-05-19 11:02:48 -04:00
Peter Johanson
64dadfb336 refactor(tests): Move remaining tests to posix 64.
* Update docs and fix up a few lingering tests
  to consistently use native_posix_64 target.
2022-05-19 10:55:23 -04:00
dependabot[bot]
37f4f9eb4a chore(deps-dev): bump @types/react-helmet from 6.1.0 to 6.1.5 in /docs
Bumps [@types/react-helmet](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/react-helmet) from 6.1.0 to 6.1.5.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/react-helmet)

---
updated-dependencies:
- dependency-name: "@types/react-helmet"
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-05-19 10:53:43 -04:00
dependabot[bot]
53d70dd08a chore(deps-dev): bump eslint-config-prettier in /docs
Bumps [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier) from 8.3.0 to 8.5.0.
- [Release notes](https://github.com/prettier/eslint-config-prettier/releases)
- [Changelog](https://github.com/prettier/eslint-config-prettier/blob/main/CHANGELOG.md)
- [Commits](https://github.com/prettier/eslint-config-prettier/compare/v8.3.0...v8.5.0)

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

Signed-off-by: dependabot[bot] <support@github.com>
2022-05-18 01:26:46 -04:00
dependabot[bot]
56fb07dffe chore(deps-dev): bump webpack from 5.58.2 to 5.72.1 in /docs
Bumps [webpack](https://github.com/webpack/webpack) from 5.58.2 to 5.72.1.
- [Release notes](https://github.com/webpack/webpack/releases)
- [Commits](https://github.com/webpack/webpack/compare/v5.58.2...v5.72.1)

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

Signed-off-by: dependabot[bot] <support@github.com>
2022-05-17 01:24:30 -04:00
Stefán Páll Sturluson
d7ba7a1bee
fix(codes): typo in C_SUBTITLES. 2022-05-17 00:29:53 -04:00
Peter Johanson
6227866e8c feat(setup): Disallow split w/ wired controller.
For now, disallow wired split combination during setup.
2022-05-03 05:10:09 -04:00
Kurtis Lew
8bbbf530a7 fix(docs): Remove code-snippet backticks from customization.md title
Discussed here: https://discord.com/channels/719497620560543766/883452966114324550/970385441134104747

Code snippets in titles are not formatted properly in page titles
2022-05-01 21:14:19 +01:00
Joel Spadin
d7b912b798 fix(docs): Fix broken links in FAQs 2022-04-30 09:34:30 +01:00
Dom H
e5843b268c fix(docs): Clarify timeout-ms for Combos 2022-04-29 14:13:04 -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
Kurtis Lew
2a38849f4e fix(docs): Fix link to BT_CTLR_TX_PWR adjustment in Zephyr docs 2022-04-25 19:59:20 +01:00
Thomas de Barochez
a24cc5d688 doc(backlight): small typo 2022-04-21 18:42:54 -05:00
Peter Johanson
56465354cf feat(blog): Add second birthday post. 2022-04-21 04:05:25 +00:00
Peter Johanson
c8c273d83b feat(docs): Add TOC to supported hardware page. 2022-04-19 07:05:26 -04:00
dependabot[bot]
158ac27207 chore(deps-dev): bump eslint-plugin-mdx from 1.13.0 to 1.17.0 in /docs
Bumps [eslint-plugin-mdx](https://github.com/mdx-js/eslint-mdx) from 1.13.0 to 1.17.0.
- [Release notes](https://github.com/mdx-js/eslint-mdx/releases)
- [Changelog](https://github.com/mdx-js/eslint-mdx/blob/master/CHANGELOG.md)
- [Commits](https://github.com/mdx-js/eslint-mdx/compare/v1.13.0...v1.17.0)

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

Signed-off-by: dependabot[bot] <support@github.com>
2022-04-19 00:56:13 -04:00
dependabot[bot]
e13ea3fbfb chore(deps): bump @fortawesome/react-fontawesome in /docs
Bumps [@fortawesome/react-fontawesome](https://github.com/FortAwesome/react-fontawesome) from 0.1.16 to 0.1.18.
- [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.16...0.1.18)

---
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>
2022-04-19 00:08:14 -04:00
dependabot[bot]
56d5f4153c chore(deps): bump async from 2.6.3 to 2.6.4 in /docs
Bumps [async](https://github.com/caolan/async) from 2.6.3 to 2.6.4.
- [Release notes](https://github.com/caolan/async/releases)
- [Changelog](https://github.com/caolan/async/blob/v2.6.4/CHANGELOG.md)
- [Commits](https://github.com/caolan/async/compare/v2.6.3...v2.6.4)

---
updated-dependencies:
- dependency-name: async
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-04-19 00:06:33 -04:00
Dom H
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
2022-04-18 22:48:53 -05:00
Dom H
3e294375b6 feat(docs): Provide current status of Displays 2022-04-18 12:15:49 -04:00
Joel Spadin
b7b026f20c feat(docs): Add battery sensor documentation 2022-04-17 11:30:57 -04:00
DoctorNefario
c7a6836735
fix(docs): Add #include to Underglow upgrade notes 2022-04-14 17:29:09 +01:00
Herald
ebc6275a72
fix(docs): Document ignore-modifiers and quick-release for sticky keys (#1228) 2022-04-14 16:13:33 +01:00
DoctorNefario
0e54603ec6 fix(docs): Clarify backlight & underglow use cases
This should help reduce confusion for newcomers.
2022-04-14 16:03:29 +01:00
Peter Johanson
8c99313a67 feat(blog): Add SOTF #5. 2022-04-10 22:11:57 -04:00
Cem Aksoylar
32c8737a22 fix(docs): Fix cmake version requirements 2022-04-08 07:18:44 -04: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
dependabot[bot]
642fe0ce3d chore(deps): bump browserslist from 4.14.5 to 4.20.2 in /docs
Bumps [browserslist](https://github.com/browserslist/browserslist) from 4.14.5 to 4.20.2.
- [Release notes](https://github.com/browserslist/browserslist/releases)
- [Changelog](https://github.com/browserslist/browserslist/blob/main/CHANGELOG.md)
- [Commits](https://github.com/browserslist/browserslist/compare/4.14.5...4.20.2)

---
updated-dependencies:
- dependency-name: browserslist
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-04-06 09:21:01 -04:00
dependabot[bot]
5c83be0de1 chore(deps): bump path-parse from 1.0.6 to 1.0.7 in /docs
Bumps [path-parse](https://github.com/jbgutierrez/path-parse) from 1.0.6 to 1.0.7.
- [Release notes](https://github.com/jbgutierrez/path-parse/releases)
- [Commits](https://github.com/jbgutierrez/path-parse/commits/v1.0.7)

---
updated-dependencies:
- dependency-name: path-parse
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-04-06 09:19:26 -04:00
Peter Johanson
6501e68c2d fix(docs): Remove breadcrumbs (for now)
* Remove breadcrumbs until they're useful
  with content for each level in our docs.
2022-04-06 06:01:39 -04:00
Peter Johanson
c259c7b27a fix(docs): Updated proper API key. 2022-04-06 06:01:39 -04:00
Peter Johanson
17affd8081 refactor(docs): Bump typescript dependency.
* Newer `tsc` needed for Docusaurus changes.
2022-04-06 06:01:39 -04:00
Peter Johanson
60d367cbb9 refactor(docs): Bump to docusaurus 2.0.0-beta.18
* Fix up the config to use proper locations.
2022-04-06 06:01:39 -04:00
dependabot[bot]
089602fec0 chore(deps): bump url-parse from 1.4.7 to 1.5.10 in /docs
Bumps [url-parse](https://github.com/unshiftio/url-parse) from 1.4.7 to 1.5.10.
- [Release notes](https://github.com/unshiftio/url-parse/releases)
- [Commits](https://github.com/unshiftio/url-parse/compare/1.4.7...1.5.10)

---
updated-dependencies:
- dependency-name: url-parse
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-04-05 10:39:41 -04:00
dependabot[bot]
ec80a8139e chore(deps): bump minimist from 1.2.5 to 1.2.6 in /docs
Bumps [minimist](https://github.com/substack/minimist) from 1.2.5 to 1.2.6.
- [Release notes](https://github.com/substack/minimist/releases)
- [Commits](https://github.com/substack/minimist/compare/1.2.5...1.2.6)

---
updated-dependencies:
- dependency-name: minimist
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-04-05 10:37:43 -04:00
dependabot[bot]
e77c3fc8d1 chore(deps): bump axios from 0.21.1 to 0.21.4 in /docs
Bumps [axios](https://github.com/axios/axios) from 0.21.1 to 0.21.4.
- [Release notes](https://github.com/axios/axios/releases)
- [Changelog](https://github.com/axios/axios/blob/master/CHANGELOG.md)
- [Commits](https://github.com/axios/axios/compare/v0.21.1...v0.21.4)

---
updated-dependencies:
- dependency-name: axios
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-04-05 10:36:38 -04:00
Cem Aksoylar
27ba5fdfb3 fix(docs): Improve powershell command for setup script for failure cases 2022-04-03 08:39:15 +01:00
Peter Johanson
fbe0e822dc fix(blog): Whitespace issue w/ blog addition. 2022-04-03 05:31:05 +00:00
Peter Johanson
140c9c546d fix(blog): Add note about DTS output step.
* The DTS output step needs to be removed for the builds.
2022-04-03 05:10:37 +00:00
Peter Johanson
b4db1b893b feat(blog): Add Zephyr 3.0 upgrade post. 2022-04-03 00:10:29 -04:00
Peter Johanson
3c4ff9c82c fix(docs): Proper links to new SDK version. 2022-04-03 00:10:29 -04:00
Peter Johanson
bf2fc68070 fix(underglow): Add newly required color-mapping prop. 2022-04-03 00:10:29 -04: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
Joel Spadin
1293175744 fix(docs): Allow CORS for hardware-metadata.json
Enabled CORS so external tools can fetch the metadata file.
2022-03-30 07:13:13 -04:00
Albert Y
59d2744a4f
feat(docs): Add settings_reset build instructions (#1197)
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2022-03-30 09:56:47 +01:00
rhhub
b79b6363a7
fix(docs): Clear up ambiguity on supported hardware page (#1200) 2022-03-30 08:51:12 +01:00
Joel Spadin
ed41d42874 feat(docs): Add aggregated metadata to website
Added /hardware-metadata.json to the ZMK website.
This gives external tools a way to grab all hardware metadata at once.
2022-03-29 23:03:56 -04:00
Cem Aksoylar
92e7618346 fix(docs): Fix Windows unicode macro example 2022-03-28 21:16:48 -04:00
Albert Y
5f35a0bf58
feat(docs): Add note on locating tmp file in GH actions (#1177)
Co-authored-by: Dom H <dom@hxy.io>
2022-03-28 08:44:34 +01:00
Peter Johanson
34e1de23fb feat(docs): Document the macro behavior. 2022-03-23 23:42:54 -04:00
Kurtis Lew
58c7c0ee0c
feat(docs): Add tap-dance to feature matrix 2022-03-16 11:06:55 -04:00
Kurtis Lew
32ebe2cfb5
feat(behaviors): Add Tap-Dance behavior 2022-03-16 01:08:42 -04:00
Peter Johanson
37c830fb8a feat: Add blog post with Zephyr 3.0 prep. 2022-03-08 14:14:15 -05:00
Caleb Goates
594cc55e0c fix(docs): Update instructions to find settings reset firmware 2022-03-08 06:21:53 -05:00
dependabot[bot]
5cc9b8f71a chore(deps): bump follow-redirects from 1.14.7 to 1.14.8 in /docs
Bumps [follow-redirects](https://github.com/follow-redirects/follow-redirects) from 1.14.7 to 1.14.8.
- [Release notes](https://github.com/follow-redirects/follow-redirects/releases)
- [Commits](https://github.com/follow-redirects/follow-redirects/compare/v1.14.7...v1.14.8)

---
updated-dependencies:
- dependency-name: follow-redirects
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-02-19 23:42:39 -05:00
Dom H
322cc14da6 fix(docs): Remove trailing whitespace
Otherwise, prettier fails.
2022-02-16 15:29:02 +00:00
chadbailey59
43ffa6c760
docs: Clarifications within New Shield page (#1130)
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2022-02-16 11:46:15 +00:00
Dom H
8e91e5ada1 fix(docs): Add behaviors/key-repeat to sidebar 2022-02-12 11:22:19 -05: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
Albert Y
7474d985c9
docs: Add guide to build additional keyboards with GH Actions (#1126)
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2022-02-11 10:05:04 +00:00
Cem Aksoylar
c18c3d9106 feat(docs): Add note for combos invoking source-specific behaviors 2022-02-07 09:30:16 -05:00
Cem Aksoylar
76268bae8f feat(docs): Document locality for backlight behaviors 2022-02-07 09:30:16 -05:00
Cem Aksoylar
a1ef7c8090 feat(docs): Document locality for RGB underglow behaviors 2022-02-07 09:30:16 -05:00
Cem Aksoylar
c0b5985ac7 feat(docs): Document locality for power management behaviors 2022-02-07 09:30:16 -05:00
Cem Aksoylar
5c4bf8a3bb feat(docs): Document locality for reset behaviors 2022-02-07 09:30:16 -05:00
Alessandro Bortolin
be94e04963 docs(backlight): improve documentation 2022-02-05 23:40:18 -05:00
Alessandro Bortolin
13a4515300 feat(backlight): add command to cycle brightness 2022-02-05 23:40:18 -05:00
Alessandro Bortolin
2c0fe3934d feat(backlight): add tests 2022-02-05 23:40:18 -05:00
Alessandro Bortolin
ce843825e8 refactor(backlight): code cleanup 2022-02-05 23:40:18 -05:00
Alessandro Bortolin
f8bf8bffd5 feat(docs): add backlight to power profiler 2022-02-05 23:40:18 -05:00
Alessandro Bortolin
da41391b1f feat(docs): add backlight documentation 2022-02-05 23:40:18 -05:00
dependabot[bot]
84365e6def chore(deps-dev): bump json-schema-to-typescript in /docs
Bumps [json-schema-to-typescript](https://github.com/bcherny/json-schema-to-typescript) from 10.1.3 to 10.1.5.
- [Release notes](https://github.com/bcherny/json-schema-to-typescript/releases)
- [Changelog](https://github.com/bcherny/json-schema-to-typescript/blob/master/CHANGELOG.md)
- [Commits](https://github.com/bcherny/json-schema-to-typescript/commits)

---
updated-dependencies:
- dependency-name: json-schema-to-typescript
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-02-05 23:31:00 -05:00