mirror of https://github.com/zmkfirmware/zmk.git
354cff9c36
* fix(docs): Improve link and code highlight contrast Reset the theme's primary colors to the defaults, since the color of links was a bit too low contrast in the dark theme. The default primary color is a very similar but slightly lighter shade of blue. The background color of highlighted lines in code blocks is also fairly low contrast, but it needs to be in order to keep the text readable. To add contrast here, we now add a colored block to the left side of a highlighted line. * fix(docs): Improve ZMK setup instructions This makes several improvements to the instructions for installing and using ZMK CLI: - Windows Terminal is also named "Terminal", so reworded the terminal instructions to not separate Windows from other OSes. - Specified that Windows Terminal should always be used on Windows, as on older installations of Windows, the default terminal when opening PowerShell may be the legacy console host, which may not support some of the VT sequences used by ZMK CLI. - Switched from pipx to uv. This eliminates the need for instructions on installing Python, as uv will automatically install a supported version of Python if needed. - Updated the instructions for running "zmk init", as ZMK CLI version 0.4.0 switched from immediately asking for a repo URL to prompting the user to select between creating a new repo or cloning an existing one first. - Since for a new user, having a keymap compile successfully on the first attempt after modifying it may be the exception rather than the norm, added a note about error messages in GitHub actions with a link to the troubleshooting page. Also added instructions for updating ZMK CLI to the latest version on the ZMK CLI page. |
||
|---|---|---|
| .. | ||
| 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.