zmk/docs
Nick Winans d964faaa89 fix(docs): Standardize all internal links 2021-08-12 20:07:45 -04:00
..
blog feat(docs): Add Zephyr 2.5 blog post. 2021-07-17 17:04:25 -04:00
docs fix(docs): Standardize all internal links 2021-08-12 20:07:45 -04:00
src fix(docs): Appease Prettier 2021-08-08 13:17:27 -05:00
static fix(docs): Fix keymap upgrader 2021-07-24 13:12:54 -05:00
.eslintignore
.eslintrc.js fix(docs): Updated eslint config for unified prettier setup. 2021-05-05 00:54:55 -04:00
.gitignore
.nvmrc
.prettierignore
.prettierrc.js
README.md
docusaurus.config.js refactor: Move to new zmk.dev domain name. 2021-06-10 09:27:57 -04:00
netlify.toml fix(docs): Add permanent redict to zmk.dev domain. 2021-06-10 10:06:41 -04:00
package-lock.json chore(deps-dev): bump eslint from 7.29.0 to 7.32.0 in /docs 2021-08-02 19:09:47 -04:00
package.json chore(deps-dev): bump eslint from 7.29.0 to 7.32.0 in /docs 2021-08-02 19:09:47 -04:00
sidebars.js Docs: added mod morph page (#749) 2021-04-05 18:04:38 -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.