Commit graph

641 commits

Author SHA1 Message Date
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
dependabot[bot]
8678a537c6 chore(deps): bump shelljs from 0.8.4 to 0.8.5 in /docs
Bumps [shelljs](https://github.com/shelljs/shelljs) from 0.8.4 to 0.8.5.
- [Release notes](https://github.com/shelljs/shelljs/releases)
- [Changelog](https://github.com/shelljs/shelljs/blob/master/CHANGELOG.md)
- [Commits](https://github.com/shelljs/shelljs/compare/v0.8.4...v0.8.5)

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

Signed-off-by: dependabot[bot] <support@github.com>
2022-02-05 23:23:56 -05:00
dependabot[bot]
614e0f1b2b chore(deps): bump follow-redirects from 1.14.1 to 1.14.7 in /docs
Bumps [follow-redirects](https://github.com/follow-redirects/follow-redirects) from 1.14.1 to 1.14.7.
- [Release notes](https://github.com/follow-redirects/follow-redirects/releases)
- [Commits](https://github.com/follow-redirects/follow-redirects/compare/v1.14.1...v1.14.7)

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

Signed-off-by: dependabot[bot] <support@github.com>
2022-02-05 23:21:21 -05:00
Peter Johanson
70bb7c9334 feat(behaviors): &key_repeat behavior + tests.
* Add new `&key_repeat` behavior that captures and re-sends
  the most recently triggered keycode.

Closes: #853
2022-01-30 22:47:34 -05:00
dependabot[bot]
ac3c3170bd chore(deps-dev): bump eslint-plugin-react from 7.24.0 to 7.28.0 in /docs
Bumps [eslint-plugin-react](https://github.com/yannickcr/eslint-plugin-react) from 7.24.0 to 7.28.0.
- [Release notes](https://github.com/yannickcr/eslint-plugin-react/releases)
- [Changelog](https://github.com/yannickcr/eslint-plugin-react/blob/master/CHANGELOG.md)
- [Commits](https://github.com/yannickcr/eslint-plugin-react/compare/v7.24.0...v7.28.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-01-30 22:45:26 -05:00
Albert Y
2ad8f687c0
docs: Add a note for GitHub SSH scheme (#1089)
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2022-01-13 09:23:43 +00:00
KingCoinless
e7a52e2cee
docs(codes): Windows Support: Media Controls
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2022-01-02 10:44:55 +00:00
Evan Callicoat
be343674de
docs: Fix typos and inconsistent spellings (#1079) 2022-01-02 10:34:21 +00:00
Kiessling
7b2edbad43 docs(codes): Windows Support: Language/International Inputs 2021-12-29 10:43:02 +00:00
Kiessling
1e4f0147ad docs(codes): Windows Support: Audio Controls 2021-12-29 10:42:34 +00:00
Kiessling
4a547555bf docs(codes): Windows Support: Workflow Commands and Locks 2021-12-29 10:41:58 +00:00
Kiessling
ee0f24412b docs(codes): Windows Support: Symbols, Operations, and Punctuation 2021-12-29 10:41:30 +00:00
KingCoinless
3879267615
docs(codes): Windows Support: Display Adjustment Commands
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2021-12-29 10:40:31 +00:00
Cem Aksoylar
93e76835e4 fix(setup): Use right flags for curl when wget doesn't exist. 2021-12-28 22:13:46 +00:00
Cem Aksoylar
ef0d088cb8 feat(docs): Link to outputs page in troubleshooting re: BT output 2021-12-28 21:17:48 +00:00
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