zmk/docs
onebigdoor 4c92a4e50f
docs(codes): improve macOS support data
Tested with Karabiner-EventViewer as well as some manual checks.

PR: #377
See: #375
2020-12-09 13:58:24 +00:00
..
blog refactor(docs): Change `behavior` to `behaviors` 2020-11-16 15:33:44 -05:00
docs docs(codes): improve macOS support data 2020-12-09 13:58:24 +00:00
src docs(codes): improve macOS support data 2020-12-09 13:58:24 +00:00
static feat(shields): add CRBN shield 2020-12-07 16:49:37 +00:00
.eslintignore
.eslintrc.js
.gitignore
.nvmrc
.prettierignore
.prettierrc.js
README.md
docusaurus.config.js refactor(docs): Move `dev-` documents into `/development` 2020-11-20 22:31:56 -05:00
netlify.toml
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
sidebars.js refactor(docs): Integrate `Dev Guides` into `Development` section 2020-11-20 22:31:56 -05: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.