History

Nick Winans 0c6686f6e8 docs(split): Remove USB configuration on right half		2021-01-08 16:51:50 -05:00
..
blog	refactor(docs): Change `behavior` to `behaviors`	2020-11-16 15:33:44 -05:00
docs	docs(split): Remove USB configuration on right half	2021-01-08 16:51:50 -05:00
src	docs(codes): improve macOS support data (volume, brightness, media controls)	2021-01-01 11:06:40 +00:00
static	fix(setup): Fix typo for split variable assignment	2021-01-08 11:11:20 -05:00
.eslintignore	docs: Add eslint support	2020-10-25 21:23:16 +00:00
.eslintrc.js	docs: Add eslint-mdx support	2020-10-25 21:25:01 +00: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	docs: Add prettier support	2020-10-25 21:24:55 +00:00
.prettierrc.js	docs: Set prettier endOfLine to auto	2020-10-26 05:28:31 +00:00
README.md	fix(docs): Explicit CC-BY-NC-SA license for docs.	2020-10-26 23:15:48 -04:00
docusaurus.config.js	feat(docs): add keymap upgrader	2020-12-10 12:23:05 +00:00
netlify.toml	Move the netlify.toml file into docs/	2020-07-03 10:43:27 -04:00
package-lock.json	feat(docs): add keymap upgrader	2020-12-10 12:23:05 +00:00
package.json	feat(docs): add keymap upgrader	2020-12-10 12:23:05 +00:00
sidebars.js	feat(docs): add keymap upgrader	2020-12-10 12:23:05 +00:00

Website

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

License

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

$ npm ci

$ 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.

$ npm build

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