History

innovaker 5f83568a93 docs(key press): Replace deprecated `NUM_1` with `N1` This should've been changed in: `b8f6d52ae5`		2020-11-05 11:47:34 -05:00
..
blog	Add blog post about #322	2020-11-03 15:56:20 -05:00
docs	docs(key press): Replace deprecated `NUM_1` with `N1`	2020-11-05 11:47:34 -05:00
src	fix: eslint proptype errors	2020-10-25 23:45:28 +00:00
static	Add NIBBLE shield	2020-10-27 12:44:59 -07: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
docusaurus.config.js	fix(docs): Explicit CC-BY-NC-SA license for docs.	2020-10-26 23:15:48 -04:00
netlify.toml	Move the netlify.toml file into docs/	2020-07-03 10:43:27 -04:00
package-lock.json	docs: Add eslint-mdx support	2020-10-25 21:25:01 +00:00
package.json	feat(docs): Add eslint and prettier GH Actions.	2020-11-03 15:02:41 -05:00
README.md	fix(docs): Explicit CC-BY-NC-SA license for docs.	2020-10-26 23:15:48 -04:00
sidebars.js	feat(endpoints): rename behavior to outputs	2020-10-28 18:15:05 -05: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.