mirror of https://github.com/zmkfirmware/zmk.git
930b5cc058
This deletes the Bash and PowerShell setup scripts in favor of using ZMK CLI. The old setup scripts are broken, since the config repo template uses ZMK version 0.3, while the setup scripts use hardware metadata from the main branch. ZMK CLI doesn't have this issue, because it clones the version of ZMK listed in the config repo to get hardware metadata. Much of the "Installing ZMK" page has been rewritten to give instructions for installing ZMK CLI and using it to create and modify a config repo. The previously-hidden page on ZMK CLI has been added to the sidebar and repurposed into general documentation for the tool. |
||
|---|---|---|
| .. | ||
| 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 | ||
| zmk-release-versions.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.