mirror of https://github.com/zmkfirmware/zmk.git
ee69b9e3c7
* docs: Added a dedicated page on ZMK events * docs: Apply suggestions from code review Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com> * docs: Apply suggestions from code review Bring the code snipper in new-behavior back, touchups on the page * docs: clarify "calling" hold tap Adjustment after feedback from code review --------- Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| blog | ||
| docs | ||
| src | ||
| static | ||
| .gitignore | ||
| .nvmrc | ||
| .prettierignore | ||
| .prettierrc.js | ||
| README.md | ||
| docusaurus.config.js | ||
| eslint.config.mjs | ||
| netlify-ignore-command.sh | ||
| netlify.toml | ||
| package-lock.json | ||
| package.json | ||
| sidebars.js | ||
| tsconfig.json | ||
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.