mirror of
https://github.com/zmkfirmware/zmk.git
synced 2026-03-20 04:55:20 -05:00
45700887ba
* Suggest using cu for USB log viewing on macOS It may not be as friendly, but cu should be available while tio could be hard to install. * Polish wording Co-authored-by: Nicolas Munnich <98408764+nmunnich@users.noreply.github.com> * Suggest "man cu" for how to use this tool --------- Co-authored-by: Nicolas Munnich <98408764+nmunnich@users.noreply.github.com>
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.