zmk/docs
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
.eslintrc.js
.gitignore
.nvmrc
.prettierignore
.prettierrc.js
README.md
docusaurus.config.js feat(docs): add keymap upgrader 2020-12-10 12:23:05 +00:00
netlify.toml
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

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.