Currently this is only documented in the zephyr 3.0 upgrade blog. This explicitly documents it as well as when it doesn't need to be applied (i.e. when a mcu board is already in use). |
||
---|---|---|
.. | ||
blog | ||
docs | ||
src | ||
static | ||
.eslintignore | ||
.eslintrc.js | ||
.gitignore | ||
.nvmrc | ||
.prettierignore | ||
.prettierrc.js | ||
docusaurus.config.js | ||
netlify.toml | ||
package-lock.json | ||
package.json | ||
README.md | ||
sidebars.js | ||
tsconfig.json |
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.