kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
1508 commits 18 branches 0 tags 93 MiB
Commit graph

492 commits

Author SHA1 Message Date
Richard Titmuss
824cf2545d 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-11-19 08:41:20 -08:00
nevin
e4eaa89eff fix: Use correct Quotation marks on line 65 (#942) 2021-11-19 08:41:20 -08:00
Cem Aksoylar
7dc51f14c5 feat(docs): Add note to clarify shared .conf files do not apply outside zmk-config 2021-11-19 08:41:20 -08:00
Peter Johanson
c76d5b34ff fix(setup): Fix setup.ps1 to check Get-Acl exists 
* `Get-Acl` not found in Linux Powershell version, so only call it
  if it exists.
 2021-11-19 08:41:20 -08:00
Peter Johanson
8dc7e1b944 refactor(docs): Remove build.yml for new shield. 
* No longer recommending that all new shields get added to the
  build matrix in `build.yml`, so we avoid conflicts.
 2021-11-19 08:41:20 -08:00
Peter Johanson
1d45069dee fix(docs): Deploy when boards/shields change. 2021-11-19 08:41:20 -08:00
Peter Johanson
8244b76c94 docs: Add docs on hardware metadata files. 2021-11-19 08:41:20 -08:00
Peter Johanson
973cd3a6e1 feat: Generate setup scripts from metadata. 2021-11-19 08:41:20 -08:00
Peter Johanson
f414d64242 feat(docs): Type check the docs TSX components. 2021-11-19 08:41:20 -08:00
Peter Johanson
52f35ae20e feat(docs): Add dynamic hardware list component. 2021-11-19 08:41:20 -08:00
Peter Johanson
dee6c04b20 feat(docs): Add TS type gen, metadata JSON gen 
* Generate TS types from new hardware metadata schema.
* Aggregate all hw metadata YAML into one aggregate JSON
  file for consumption by others.
 2021-11-19 08:41:20 -08:00
Cem Aksoylar
9e171e26b3 fix: Add semicolons for tidbit and eek in setup script 2021-11-19 08:41:20 -08:00
chad3814
0f0403a73d fix typo 
"load your newly flashed firmware" not "load your newfly flashed fireware"
 2021-11-19 08:41:20 -08:00
Nick Winans
09c049b531 fix(docs): Standardize all internal links 2021-11-19 08:41:20 -08:00
chad3814
91fbae02ad fix(docs): Fix "All" typo 2021-11-19 08:41:20 -08:00
Joel Spadin
eccabed3ce fix(docs): Appease Prettier 
Fixed code formatting in docs files.
 2021-11-19 08:41:20 -08:00
Peter Johanson
13151de885 Add warning about peripheral encoders. 2021-11-19 08:41:20 -08:00
dependabot[bot]
790b3ccce6 chore(deps-dev): bump eslint from 7.29.0 to 7.32.0 in /docs 
Bumps [eslint](https://github.com/eslint/eslint) from 7.29.0 to 7.32.0.
- [Release notes](https://github.com/eslint/eslint/releases)
- [Changelog](https://github.com/eslint/eslint/blob/master/CHANGELOG.md)
- [Commits](https://github.com/eslint/eslint/compare/v7.29.0...v7.32.0)

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

Signed-off-by: dependabot[bot] <support@github.com>
 2021-11-19 08:41:20 -08:00
Felix Sargent
44a8206860 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-11-19 08:41:19 -08:00
Joel Spadin
788bdf7d73 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-11-19 08:41:19 -08:00
Joel Spadin
4faaa19a16 docs: Switch back to package version 2 
package-lock.json was rewritten to version 1 in
13dbbefcb4.
 2021-11-19 08:41:19 -08:00
Peter Johanson
da295d04e6 fix: Add missing semicolon for nano V2 case. 2021-11-19 08:41:19 -08:00
innovaker
4083c48768 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-11-19 08:41:19 -08:00
Peter Johanson
23e2f3d4f1 chore(deps): bump @docusaurus/* to 2.0.0-beta.3 2021-11-19 08:41:19 -08:00
Peter Johanson
4ad8dd3499 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-11-19 08:41:19 -08:00
innovaker
3ece4e97c5 docs: bump Zephyr documentation links to Zephyr v2.5.0 
PR: https://github.com/zmkfirmware/zmk/pull/736
 2021-11-19 08:41:19 -08:00
innovaker
de028afbef 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-11-19 08:41:19 -08:00
innovaker
057f6ee480 docs(setup): bump ZSDK_VERSION to 0.12.4 
PR: https://github.com/zmkfirmware/zmk/pull/736
 2021-11-19 08:41:19 -08:00
Nick Winans
ed45728af5 feat(docs): Add nice!nano v2 to scripts, actions, and documentation 
asdf

asdf


asdf
 2021-11-19 08:41:19 -08:00
dependabot[bot]
461c5000cc 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-11-19 08:41:19 -08:00
dependabot[bot]
254d2070c9 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-11-19 08:41:19 -08:00
dependabot[bot]
6d4e9e58bb 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-11-19 08:41:19 -08:00
innovaker
e40d890227 docs(setup): fix whitespace in Fedora toolchain install command 
Aligns Fedora whitespace with Debian.
 2021-11-19 08:41:19 -08:00
innovaker
b054a7e36b docs(setup): remove extra slash from Fedora toolchain install command 2021-11-19 08:41:19 -08:00
innovaker
915d10711f docs(setup): fix whitespace mismatch in host dependencies 
Replaces spaces with tabs (bzip2).
 2021-11-19 08:41:19 -08: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