History

innovaker ff638eb010 docs(codes): Add (key) codes documentation Create codes documentation for standardized keys. Closes #218. Fixes #308. Ref #21.		2020-11-06 15:02:12 -05:00
..
blog	Add blog post about #322	2020-11-03 15:56:20 -05:00
docs	docs(codes): Add (key) codes documentation	2020-11-06 15:02:12 -05:00
src	docs(codes): Add (key) codes documentation	2020-11-06 15:02:12 -05: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	docs(codes): Add (key) codes documentation	2020-11-06 15:02:12 -05:00
netlify.toml	Move the netlify.toml file into docs/	2020-07-03 10:43:27 -04:00
package-lock.json	docs(codes): Add (key) codes documentation	2020-11-06 15:02:12 -05:00
package.json	docs(codes): Add (key) codes documentation	2020-11-06 15:02:12 -05:00
README.md	fix(docs): Explicit CC-BY-NC-SA license for docs.	2020-10-26 23:15:48 -04:00
sidebars.js	docs(codes): Add (key) codes documentation	2020-11-06 15:02:12 -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.