zmk/docs/src
Joel Spadin 354cff9c36
fix(docs): Improve ZMK setup instructions (#3209)
* 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.
2026-01-17 20:00:01 -06:00
..
components chore(docs): Fix prettier warnings (#2952) 2025-06-01 12:02:39 -07:00
css fix(docs): Improve ZMK setup instructions (#3209) 2026-01-17 20:00:01 -06:00
data docs: K_VOLUME_UP and K_VOLUME_DOWN work in macOS (#3057) 2025-09-12 14:08:17 +01:00
docusaurus-tree-sitter-plugin feat(studio): Initial RPC infrastructure and subsystems. 2024-08-15 11:45:18 -06:00
hardware-metadata-collection-plugin feat(docs): Generate new shield interconnect docs. 2022-12-23 02:41:35 -06:00
hardware-metadata-static-plugin chore: Add typescript support to eslint, fix errors (#2923) 2025-04-22 20:51:41 -07:00
hardware-schema-typescript-plugin feat(docs): Add dynamic hardware list component. 2021-09-11 00:50:36 -04:00
keymap-upgrade chore(docs): Fix prettier warnings (#2952) 2025-06-01 12:02:39 -07:00
pages fix(docs): remove title as alt text (#2922) 2025-04-20 10:41:13 +02:00
theme docs: Add release version to the docs, with links and warning banner (#3122) 2025-12-07 03:43:13 -05:00
utils feat(docs): Add power profiler 2021-03-11 16:31:34 -05:00
.gitignore feat(docs): Add TS type gen, metadata JSON gen 2021-09-11 00:50:36 -04:00
footnotes.js docs(codes): Add (key) codes documentation 2020-11-06 15:02:12 -05:00
groups.js docs(codes): Add (key) codes documentation 2020-11-06 15:02:12 -05:00
hid-usage.js docs(codes): Add (key) codes documentation 2020-11-06 15:02:12 -05:00
hid.js docs(codes): Add (key) codes documentation 2020-11-06 15:02:12 -05:00