zmkfirmware
/
zmk
mirror of https://github.com/zmkfirmware/zmk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
zmk/docs
History
Nick Winans e6645882c3 feat(docs): Update documentation to match new Pro Micro nodes 2021-09-25 23:09:21 -04:00
..
blog feat(docs): Add Zephyr 2.5 blog post. 2021-07-17 17:04:25 -04:00
docs feat(docs): Update documentation to match new Pro Micro nodes 2021-09-25 23:09:21 -04:00
src fix(setup): Fix sed delimiters for Cradio 2021-09-24 15:56:36 -04:00
static feat: Generate setup scripts from metadata. 2021-09-11 00:50:36 -04:00
.eslintignore
…
.eslintrc.js fix(docs): Updated eslint config for unified prettier setup. 2021-05-05 00:54:55 -04:00
.gitignore
…
.nvmrc
…
.prettierignore feat: Generate setup scripts from metadata. 2021-09-11 00:50:36 -04:00
.prettierrc.js
…
README.md
…
docusaurus.config.js feat: Generate setup scripts from metadata. 2021-09-11 00:50:36 -04:00
netlify.toml fix(docs): Deploy when boards/shields change. 2021-09-11 00:50:36 -04:00
package-lock.json feat: Generate setup scripts from metadata. 2021-09-11 00:50:36 -04:00
package.json feat: Generate setup scripts from metadata. 2021-09-11 00:50:36 -04:00
sidebars.js docs: Add docs on hardware metadata files. 2021-09-11 00:50:36 -04:00
tsconfig.json feat(docs): Type check the docs TSX components. 2021-09-11 00:50:36 -04: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.