c4c014e3d1
fix(docs): Fix typescript error
...
See https://github.com/facebook/docusaurus/issues/8226#issuecomment-1420620198
2023-05-20 01:33:11 -06:00
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
c6bf95a901
chore: Update fontawesome
2023-05-20 01:33:11 -06:00
da2599aa75
chore: Update docusaurus, react types
2023-05-20 01:33:11 -06:00
4674215551
chore: Update json-schema-to-typescript
2023-05-20 01:33:11 -06:00
d799560985
chore: Update typescript, eslint, webpack
2023-05-20 01:33:11 -06:00
48be2eedd0
fix(docs): Update QMK debounce references
2023-05-09 21:40:14 -07:00
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
7a352908ee
docs: Add pre-commit documentation
2023-04-24 16:07:04 -07:00
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
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
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
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
9d64c2a3a0
fix(docs): switch sensor rotate parameter order
2023-04-22 17:30:10 -07:00
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
83a151890c
fix(docs): Correct example keymap filename
2023-04-16 13:28:08 -07:00
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
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
134b64ef5b
fix(docs): Make link to keymap upgrader work.
2023-04-05 23:18:34 -07:00
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
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
1493620bf7
refactor(boards): Move to pinctrl.
2023-04-05 22:55:38 -07:00
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
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
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
6cb42a8060
feat(behaviors): On-release option for positional-hold-taps
2023-03-12 12:24:00 -04:00
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
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
b7d5865e40
feat(docs): additional note on bug fixed in macOS v13.1
2023-02-02 21:23:48 -05:00
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
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
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
d993b03433
feat(docs): Refer to troubleshooting in connecting split halves
2022-12-23 00:20:12 -06:00
080c47825f
feat(docs): Add caution note about split peripheral sides to user setup
2022-12-23 00:20:12 -06:00
77d60182bf
feat(docs): Recommend USB testing and warn about BT pairing in user setup
2022-12-23 00:20:12 -06:00
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
11ca0098a5
fix(docs): Disable encoders in dtsi ( #1600 )
2022-12-20 20:24:32 +00:00
781df31ec4
fix(setup): Fix conf download path in PS script
2022-12-17 17:46:22 -06:00
b8fb218a01
fix(setup): Make keymap/conf fall back to using dirname
2022-12-16 17:41:39 -06:00
408b87ae7b
fix(docs): Grammatical fixes ( #1587 )
...
Co-authored-by: Dom H <dom@hxy.io>
2022-12-14 14:51:46 +00:00
f03e29ca13
fix(config): Fix split wired detection in setup.sh.
2022-12-11 09:29:58 -06:00
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
2a42fe658e
feat(docs): Document battery widget percentage Kconfig
2022-12-10 17:08:37 -06:00
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
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
001105e318
fix(docs): Correct typo in hold-tap comparison balanced flavor
2022-12-01 20:11:31 +00:00
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
5cd608cb60
fix(docs): Correct syntax in capsword mods
2022-11-24 19:11:24 -06:00
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
c7d83fb951
fix(docs): changed MacOS to macOS as per Apple styling
2022-11-09 20:38:08 -06:00
9847a4c5d5
fix(docs): copy error not exclusive to Apple silicon
2022-11-09 14:56:22 -06:00
4e11913127
feat(docs): troubleshooting steps for macOS 13 Finder bug
2022-10-27 21:03:16 -05:00
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
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
2d7c8f6073
chore(docs): Bump docusaurus and run audit fix.
2022-10-26 23:02:54 -05:00
c9eb63199a
feat(keymaps): add NUHS/NUBS alias for Non-US-Backslash/Non-US-Hash
2022-10-17 21:48:19 -04:00
3f00f14e36
feat(docs): Added a Spelling Error Caution Notice
2022-10-15 14:00:09 -05:00
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
bdc706f88d
docs(power profiling): add nice!view
2022-10-07 20:43:12 -04:00
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
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
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
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
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
8976b353ae
fix(docs): Correct mo_tog implementation in tabbed menu
2022-09-25 20:06:20 -05:00
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
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
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
3f28a55452
fix(docs): Fix ambiguous tap-preferred desc.
2022-09-11 21:06:04 -04:00
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
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
f238001904
doc(keymaps): fix typo ( #1425 )
2022-08-12 07:37:06 -04:00
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
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
01f51f06dc
fix(docs): Fix col/row properties in kscan.md example
2022-07-27 08:17:40 -04:00
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
54aa3e6a1e
fix(docs): typo fixes
...
* Update user-setup.md
2022-07-25 23:43:56 -04:00
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
b1ce8a0d33
fix(docs): typo fixes
2022-07-12 08:47:19 +01:00
41c9d81096
fix(docs): Update config docs for split Kconfig refactor
2022-07-05 08:42:27 +01:00
19d8c5ba40
feat(docs): Document new underglow Kconfig
2022-07-05 08:42:27 +01:00
851c37e14f
fix(docs): Apply suggestions from #722 reviews
2022-07-05 08:42:27 +01:00
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
1646cd7f30
feat(docs): Add a simpler matrix transform example
2022-07-03 18:55:54 +01:00
6e67e4a3a5
feat(docs): Update direct GPIO configuration
2022-07-03 18:55:54 +01:00
74b4933980
feat(docs): Clarify descriptions of config files
2022-07-03 18:55:54 +01:00
e0e0928f9c
fix(docs): Update config docs for review feedback
2022-07-03 18:55:54 +01:00
01ffea1b47
feat(docs): Update configuration overview
2022-07-03 18:55:54 +01:00
c350f7130b
fix(docs): Fix links in config pages
2022-07-03 18:55:54 +01:00
2b122acfc3
feat(docs): Updating lighting config docs
2022-07-03 18:55:54 +01:00
e8e6b2a333
feat(docs): Update general system config docs
2022-07-03 18:55:54 +01:00
e46eaf5617
feat(docs): Update power config docs
2022-07-03 18:55:54 +01:00
71b8f9d4ac
feat(docs): Update display config docs
2022-07-03 18:55:54 +01:00
bf84481b47
feat(docs): Update behavior config docs
2022-07-03 18:55:54 +01:00
d36792db2d
feat(docs): Update kscan config docs
2022-07-03 18:55:54 +01:00
11861a4d30
docs: Add documentation for config options
2022-07-03 18:55:54 +01:00
91de215bf0
fix(docs): Add missing underglow on/off defines
2022-07-03 13:30:25 +01:00
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
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
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
Joel Spadin
Albert Y
Nick Coutsos
Nick Conway
sporkus
Josep Roca
Peter Johanson
Robert U
dependabot[bot]
Cem Aksoylar
as29
Petrus Claviger
Kyle McCreery
Kurtis Lew
Michael Anthony
byran.tech
Terence Stenvold
ebastler
Nick Winans
Joe Peterson
Nick Winans
David A. Bell
Shreyas
Anton
HanfG
GreenAirplane