mirror of https://github.com/zmkfirmware/zmk.git
cb5e605906
* docs: Split local toolchain setup for Docker in two separated approaches. This includes adding a new dropdown for Docker which lists overall steps that have to be done when setting up the environment. Furthermore, the previous documentation is no listed under VSCode and new documentation for the Devcontainer CLI has been added. Since the described approaches for VS Code and Dev Container CLI varied quiet a bit a more unified way of setting them up was added. Due to that, the documentation for building and flashing could be simplified as well. * docs: Update documentation for building and flashing for devcontainers. Moved information about creating volumes for Docker containers into the overall Docker setup documentation. Add warning for changing build directory or adding options for building at the top of the page. * feat(devcontainers): Add new volume for mounting modules. --------- Co-authored-by: Nicolas Munnich <98408764+Nick-Munnich@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| 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 | ||
| 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.