mirror of https://github.com/zmkfirmware/zmk.git
Now, instead of always defaulting to light theme, documentation, docs will default to the color scheme based by the user preference (reported by web browser as a `prefers-color-scheme` media query). It is still possible for user to change the theme by using the switch next to the search box. His preference will be remembered. |
||
|---|---|---|
| .. | ||
| blog | ||
| docs | ||
| src | ||
| static | ||
| .eslintignore | ||
| .eslintrc.js | ||
| .gitignore | ||
| .nvmrc | ||
| .prettierignore | ||
| .prettierrc.js | ||
| README.md | ||
| docusaurus.config.js | ||
| netlify.toml | ||
| package-lock.json | ||
| package.json | ||
| sidebars.js | ||
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.