afiqzudinhadi/zmk
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions

docs: Replace user setup script with ZMK CLI (#3137)

Browse source 
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.
This commit is contained in:
Joel Spadin 2025-12-14 16:20:35 -06:00 • committed by GitHub
parent 8987f3979d
commit 930b5cc058
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
8 changed files with 333 additions and 349 deletions
Download patch file Download diff file Expand all files Collapse all files

5
docs/static/.gitignore vendored
View file

@ -1,5 +0,0 @@
# Ignore generated setup script
setup.ps1
setup.sh

3
docs/static/_redirects vendored
View file

@ -22,4 +22,5 @@
/docs/development/tests /docs/development/local-toolchain/tests 301
/docs/development/guides/new-behavior /docs/development/new-behavior 301
/docs/development/hardware-integration/studio-setup /docs/development/hardware-integration/physical-layouts 301
/docs/keymaps/behaviors/mod-tap /docs/keymaps/behaviors/hold-tap#mod-tap
/docs/keymaps/behaviors/mod-tap /docs/keymaps/behaviors/hold-tap#mod-tap
/docs/user-setup-cli /docs/user-setup 301