History

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
..
blog	feat(docs): Add Zephyr 2.5 blog post.	2021-07-17 17:04:25 -04:00
docs	feat(kscan): Improve matrix debouncing	2021-10-26 23:52:13 -04:00
src	refactor: Add js-yaml dep, scrtipt gen tweaks.	2021-10-16 21:50:58 -04:00
static	feat: Generate setup scripts from metadata.	2021-09-11 00:50:36 -04:00
.eslintignore	docs: Add eslint support	2020-10-25 21:23:16 +00:00
.eslintrc.js	fix(docs): Updated eslint config for unified prettier setup.	2021-05-05 00:54:55 -04:00
.gitignore	Initial work on basic documentation.	2020-05-25 21:33:21 -04:00
.nvmrc	docs: Set netlify node version to lts/*	2020-10-26 22:55:15 +00:00
.prettierignore	feat: Generate setup scripts from metadata.	2021-09-11 00:50:36 -04:00
.prettierrc.js	docs: Set prettier endOfLine to auto	2020-10-26 05:28:31 +00:00
docusaurus.config.js	feat: Generate setup scripts from metadata.	2021-09-11 00:50:36 -04:00
netlify.toml	fix(docs): Deploy when boards/shields change.	2021-09-11 00:50:36 -04:00
package-lock.json	chore(deps): bump @fortawesome/react-fontawesome in /docs	2021-10-20 22:56:45 -04:00
package.json	chore(deps): bump @fortawesome/react-fontawesome in /docs	2021-10-20 22:56:45 -04:00
README.md	fix(docs): Explicit CC-BY-NC-SA license for docs.	2020-10-26 23:15:48 -04:00
sidebars.js	feat(kscan): Improve matrix debouncing	2021-10-26 23:52:13 -04:00
tsconfig.json	feat(docs): Type check the docs TSX components.	2021-09-11 00:50:36 -04:00

README.md

Website

This website is built using Docusaurus 2, a modern static website generator.

License

The ZMK Documentation is licensed CC-BY-NC-SA.

Installation

$ npm ci

Local Development

$ npm start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

$ npm build

This command generates static content into the build directory and can be served using any static contents hosting service.