zmk/docs
Joel Spadin 24ed1a8eaa docs(vscode): add more info for compile_commands.json path 2021-02-09 00:45:55 -05:00
..
blog
docs docs(vscode): add more info for compile_commands.json path 2021-02-09 00:45:55 -05:00
src fix(docs): Set description to our tagline 2021-01-29 23:58:42 -05:00
static fix(setup): Fix index to MakerDiary m.2 board 2021-02-03 23:10:47 -05:00
.eslintignore
.eslintrc.js
.gitignore
.nvmrc
.prettierignore
.prettierrc.js
README.md fix(docs): Explicit CC-BY-NC-SA license for docs. 2020-10-26 23:15:48 -04:00
docusaurus.config.js docs: remove redundant slash from "docs/" navigation item 2021-01-30 00:02:11 -05:00
netlify.toml
package-lock.json
package.json
sidebars.js docs: Add docs for setting up vscode 2021-02-09 00:45:55 -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.