Commit graph

474 commits

Author SHA1 Message Date
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
innovaker 47043c86e9 docs: bump Zephyr documentation links to Zephyr v2.5.0
PR: https://github.com/zmkfirmware/zmk/pull/736
2021-07-17 17:04:25 -04:00
innovaker c03046e54a docs(setup): add x86_64-linux to Zephyr SDK setup filename
See: zmkfirmware/zmk-docker@b8341e185a
PR: https://github.com/zmkfirmware/zmk/pull/736
2021-07-17 17:04:25 -04:00
innovaker 76979d293a docs(setup): bump ZSDK_VERSION to 0.12.4
PR: https://github.com/zmkfirmware/zmk/pull/736
2021-07-17 17:04:25 -04:00
Nick Winans 9c1319c4ff feat(docs): Add nice!nano v2 to scripts, actions, and documentation
asdf

asdf


asdf
2021-07-15 18:52:28 -04:00
dependabot[bot] fc014b2506 chore(deps-dev): bump eslint from 7.28.0 to 7.29.0 in /docs
Bumps [eslint](https://github.com/eslint/eslint) from 7.28.0 to 7.29.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.28.0...v7.29.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-06-21 20:13:15 +01:00
dependabot[bot] 18c988d7e9 chore(deps): bump @docusaurus/preset-classic in /docs
Bumps [@docusaurus/preset-classic](https://github.com/facebook/docusaurus/tree/HEAD/packages/docusaurus-preset-classic) from 2.0.0-beta.0 to 2.0.0-beta.1.
- [Release notes](https://github.com/facebook/docusaurus/releases)
- [Changelog](https://github.com/facebook/docusaurus/blob/master/CHANGELOG.md)
- [Commits](https://github.com/facebook/docusaurus/commits/v2.0.0-beta.1/packages/docusaurus-preset-classic)

---
updated-dependencies:
- dependency-name: "@docusaurus/preset-classic"
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2021-06-21 20:04:07 +01:00
dependabot[bot] 64ea0f2543 chore(deps): bump @docusaurus/core in /docs
Bumps [@docusaurus/core](https://github.com/facebook/docusaurus/tree/HEAD/packages/docusaurus) from 2.0.0-beta.0 to 2.0.0-beta.1.
- [Release notes](https://github.com/facebook/docusaurus/releases)
- [Changelog](https://github.com/facebook/docusaurus/blob/master/CHANGELOG.md)
- [Commits](https://github.com/facebook/docusaurus/commits/v2.0.0-beta.1/packages/docusaurus)

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

Signed-off-by: dependabot[bot] <support@github.com>
2021-06-21 17:15:34 +01:00
innovaker 576ce76ad3 docs(setup): fix whitespace in Fedora toolchain install command
Aligns Fedora whitespace with Debian.
2021-06-16 16:23:53 -05:00
innovaker 84a5fec458 docs(setup): remove extra slash from Fedora toolchain install command 2021-06-16 16:23:53 -05:00
innovaker 6f3a2529ae docs(setup): fix whitespace mismatch in host dependencies
Replaces spaces with tabs (bzip2).
2021-06-16 16:23:53 -05:00
Peter Johanson 84ce6b066a fix(docs): Add permanent redict to zmk.dev domain. 2021-06-10 10:06:41 -04:00
Peter Johanson 3f4839ec96 refactor: Move to new zmk.dev domain name. 2021-06-10 09:27:57 -04:00
Peter Johanson ba45aaa81b chore(docs): Bump prettier, and reformat w/ it.
* Bump to prettier 2.3.1.
* Re-run prettier:format to apply updated format.
2021-06-09 10:58:53 -04:00
dependabot[bot] 22800455e2 chore(deps): bump react-toastify from 6.0.9 to 7.0.4 in /docs
Bumps [react-toastify](https://github.com/fkhadra/react-toastify) from 6.0.9 to 7.0.4.
- [Release notes](https://github.com/fkhadra/react-toastify/releases)
- [Commits](https://github.com/fkhadra/react-toastify/compare/v6.0.9...v7.0.4)

---
updated-dependencies:
- dependency-name: react-toastify
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2021-06-09 10:44:31 -04:00
dependabot[bot] c83dea3742 chore(deps): bump react and react-dom in /docs
Bumps [react](https://github.com/facebook/react/tree/HEAD/packages/react) and [react-dom](https://github.com/facebook/react/tree/HEAD/packages/react-dom). These dependencies needed to be updated together.

Updates `react` from 16.14.0 to 17.0.2
- [Release notes](https://github.com/facebook/react/releases)
- [Changelog](https://github.com/facebook/react/blob/master/CHANGELOG.md)
- [Commits](https://github.com/facebook/react/commits/v17.0.2/packages/react)

Updates `react-dom` from 16.14.0 to 17.0.2
- [Release notes](https://github.com/facebook/react/releases)
- [Changelog](https://github.com/facebook/react/blob/master/CHANGELOG.md)
- [Commits](https://github.com/facebook/react/commits/v17.0.2/packages/react-dom)

---
updated-dependencies:
- dependency-name: react
  dependency-type: direct:production
  update-type: version-update:semver-major
- dependency-name: react-dom
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2021-06-09 10:30:46 -04:00
Peter Johanson 7323f78a37 fix(docs): Upgrade docusaurus, webpack/loaders.
Upgrade to the new Docusaurus 2 beta release, which also required
upgrades to newer Webpack@5, and some API fixes for TOC changes.
2021-06-09 10:12:06 -04:00
Martin Eberhardt 87ee2304a1
feat(docs): Add icon legend to the feature matrix
Add icon legend to the feature matrix
2021-06-08 21:06:20 -04:00
dependabot[bot] 33f611cc5c chore(deps): bump react-copy-to-clipboard from 5.0.2 to 5.0.3 in /docs
Bumps [react-copy-to-clipboard](https://github.com/nkbt/react-copy-to-clipboard) from 5.0.2 to 5.0.3.
- [Release notes](https://github.com/nkbt/react-copy-to-clipboard/releases)
- [Commits](https://github.com/nkbt/react-copy-to-clipboard/compare/v5.0.2...v5.0.3)

Signed-off-by: dependabot[bot] <support@github.com>
2021-06-08 21:01:07 -04:00
Dom H faa90be1ba docs(codes): Use LSHIFT/RSHIFT in keymap upgrader 2021-06-08 20:57:40 -04:00
Dom H 06a85f944f docs(codes): Refer to LSHIFT instead of LSHFT
`LSHIFT` is slightly more intuitive and should result in fewer user
errors.
2021-06-08 20:57:40 -04:00
Dom H 52ee082692 docs(codes): Add LSHIFT and RSHIFT aliases 2021-06-08 20:57:40 -04:00
Ivan Smirnov bb32005474
fix(docs): Update macos GCC embedded section with brew cmd
* Update macos GCC embedded section with brew cmd

Brew has a cask for GCC embedded, so we can make this guide more user friendly by providing it.
2021-06-08 20:56:10 -04:00
Christian Stücklberger 8196b1d46b
fix(docs): Add missing semicolon to examples
Co-authored-by: Christian Stücklberger <christian.stuecklberger@ergon.ch>
2021-05-19 11:10:29 -04:00
dependabot[bot] 5b86fdd876 chore(deps-dev): bump eslint-plugin-mdx from 1.8.2 to 1.13.0 in /docs
Bumps [eslint-plugin-mdx](https://github.com/mdx-js/eslint-mdx) from 1.8.2 to 1.13.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.8.2...v1.13.0)

Signed-off-by: dependabot[bot] <support@github.com>
2021-05-17 09:29:46 -04:00
dependabot[bot] c735bb8de6 chore(deps): bump react-dom from 16.13.1 to 16.14.0 in /docs
Bumps [react-dom](https://github.com/facebook/react/tree/HEAD/packages/react-dom) from 16.13.1 to 16.14.0.
- [Release notes](https://github.com/facebook/react/releases)
- [Changelog](https://github.com/facebook/react/blob/master/CHANGELOG.md)
- [Commits](https://github.com/facebook/react/commits/v16.14.0/packages/react-dom)

Signed-off-by: dependabot[bot] <support@github.com>
2021-05-17 00:46:57 -04:00
dependabot[bot] f26da9cd4b chore(deps): bump @fortawesome/free-solid-svg-icons in /docs
Bumps [@fortawesome/free-solid-svg-icons](https://github.com/FortAwesome/Font-Awesome) from 5.15.1 to 5.15.3.
- [Release notes](https://github.com/FortAwesome/Font-Awesome/releases)
- [Changelog](https://github.com/FortAwesome/Font-Awesome/blob/master/CHANGELOG.md)
- [Commits](https://github.com/FortAwesome/Font-Awesome/compare/5.15.1...5.15.3)

Signed-off-by: dependabot[bot] <support@github.com>
2021-05-17 00:44:59 -04:00
dependabot[bot] b09b1f3c8c chore(deps): bump @fortawesome/react-fontawesome in /docs
Bumps [@fortawesome/react-fontawesome](https://github.com/FortAwesome/react-fontawesome) from 0.1.12 to 0.1.14.
- [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/commits/0.1.14)

Signed-off-by: dependabot[bot] <support@github.com>
2021-05-17 00:19:26 -04:00
dependabot[bot] 8a39683965 chore(deps-dev): bump eslint-plugin-react from 7.21.5 to 7.23.2 in /docs
Bumps [eslint-plugin-react](https://github.com/yannickcr/eslint-plugin-react) from 7.21.5 to 7.23.2.
- [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.21.5...v7.23.2)

Signed-off-by: dependabot[bot] <support@github.com>
2021-05-17 00:18:17 -04:00
dependabot[bot] a006970825 chore(deps): bump react from 16.13.1 to 16.14.0 in /docs
Bumps [react](https://github.com/facebook/react/tree/HEAD/packages/react) from 16.13.1 to 16.14.0.
- [Release notes](https://github.com/facebook/react/releases)
- [Changelog](https://github.com/facebook/react/blob/master/CHANGELOG.md)
- [Commits](https://github.com/facebook/react/commits/v16.14.0/packages/react)

Signed-off-by: dependabot[bot] <support@github.com>
2021-05-05 01:20:27 -04:00
Peter Johanson e19cf7912d fix(docs): Updated eslint config for unified prettier setup. 2021-05-05 00:54:55 -04:00
dependabot[bot] ea57f62048 chore(deps-dev): bump eslint-config-prettier in /docs
Bumps [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier) from 6.14.0 to 8.3.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/v6.14.0...v8.3.0)

Signed-off-by: dependabot[bot] <support@github.com>
2021-05-05 00:54:55 -04:00
dependabot[bot] fa2e51b528
chore(deps-dev): bump eslint from 7.12.0 to 7.25.0 in /docs (#773)
Bumps [eslint](https://github.com/eslint/eslint) from 7.12.0 to 7.25.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.12.0...v7.25.0)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-05-05 00:24:37 -04:00
Piotr Gnus 8e235a2d65
fix(docs): Readjusted colors for dark theme for OSes in docs
Previously the colors of operating systems were the same both for dark
and light color scheme. That's not a major issue, but adjusting the
colors for the dark theme to better match the theme looks like an
improvement.

Colors were just darkened by reversing the lightness of each color taken
from the dark theme.
2021-05-05 00:21:27 -04:00
Piotr Gnus 96bd927be2
feat(docs): Added support for prefers-color-scheme in docs
Now, instead of always defaulting to light theme, documentation, docs
will default to the color scheme based by the user preference (reported
by web browser as a `prefers-color-scheme` media query).

It is still possible for user to change the theme by using the switch
next to the search box. His preference will be remembered.
2021-05-05 00:15:38 -04:00
Michael van Eerd fadb508671
fix(docs) omit layers -1 example, clarify it defaults when omitted (#757)
* fix(docs) omit layers -1 example, clarify

* comment, simplify description

* remove 'the'
2021-04-15 03:31:07 -05:00
measlesbagel 3893d50e13
Docs: added mod morph page (#749)
* docs(behaviors): add mod-morph doc page

* docs(behaviors): add mod-morph doc page

* docs(mod-morph): add note about sent modifiers

* docs(mod-morph): fixed prettier formatting
2021-04-05 18:04:38 -05:00
Nick Winans 4ef11ac4aa feat(docs): Add power profiler 2021-03-11 16:31:34 -05:00
Cody McGinnis d956193251 change "Under Development" to "Beta Testing" 2021-03-10 13:45:50 -05:00
Cody McGinnis ac50e741be move the information to its own page 2021-03-10 13:45:50 -05:00
Cody McGinnis daf10d9741 feat(docs): add information for testing PRs 2021-03-10 13:45:50 -05:00
Megamannen a7c6e080a7
Fix broken link in documentation (encoders) (#707)
* Update encoders.md

Link to "New Keyboard Shield" didn't work

* Update encoders.md

Forgot hash-link
2021-03-03 00:06:29 -06:00
Megamannen 0a7491af87
Add detailed pin mapping explanation to underglow docs (#709)
* Update underglow.md

Updated the documentation according to my current understandring of how to pin-mapping works, also split the chapter into a nrf-section and a non-nrf-section since that information isn't applicable to both

* Ran prettier and updated pin reference according to suggestion
2021-03-03 00:03:12 -06:00
Okke Formsma 0c1940bb79 feature(hold-tap): no-hold-flash for retro taps
This is an improvement on retro-tap, solving the 'flashing hold' issue
users people experience.

When the tapping-term expires, the hold key is normally pressed. When
retro-tap is enabled, this is undesirable; only an interrupted hold-tap
should trigger the hold behavior.

This change disables the hold behavior for the 'STATUS_HOLD_TIMER'
state when retro-tap is enabled, and makes sure the
'STATUS_HOLD_INTERRUPT' state will be triggered when appropriate.
2021-02-24 07:24:27 -05:00