History

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
..
blog	feat(docs): Add Zephyr 2.5 blog post.	2021-07-17 17:04:25 -04:00
docs	fix(docs): Make the modifier function examples clearer.	2021-12-01 16:56:15 -05: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(behaviors): Add caps word (`&caps_word`).	2021-11-28 22:41:35 -05: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.