zmk/docs
KemoNine f8af592a9c Update cmake note to be 3.15 which is the current minimum version. This is a re-implementation of GitHub PR 403 2020-12-02 16:01:20 -05:00
..
blog
docs Update cmake note to be 3.15 which is the current minimum version. This is a re-implementation of GitHub PR 403 2020-12-02 16:01:20 -05:00
src fix(docs/codes): Patch footnotes array support 2020-11-18 10:45:40 +00:00
static fix(setup): make sure selections are numbers 2020-11-19 19:32:53 -05: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
package.json
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.