History

Pete Johanson 8de5b120aa docs: Add release version to the docs, with links and warning banner (#3122 ) Add versions to the sidebar of the documentation, and when viewing the deployment on zmk.dev, which tracks `main`, add a banner warning about possibly prefering the docs for a particular stable release.		2025-12-07 03:43:13 -05:00
..
blog	docs: Add warning box for clearing settings for splits, generalize troubleshooting procedure (#3039 )	2025-08-19 17:27:21 -07:00
docs	feat(ble): Use appearance set in the BT_DEVICE_APPEARANCE config (#3115 )	2025-12-04 13:53:47 -05:00
src	docs: Add release version to the docs, with links and warning banner (#3122 )	2025-12-07 03:43:13 -05:00
static	…
.gitignore	…
.nvmrc	…
.prettierignore	…
.prettierrc.js	…
README.md	…
docusaurus.config.js	docs: Add release version to the docs, with links and warning banner (#3122 )	2025-12-07 03:43:13 -05:00
eslint.config.mjs	…
netlify-ignore-command.sh	…
netlify.toml	…
package-lock.json	chore(deps): bump webpack-dev-server, @docusaurus/core, @docusaurus/preset-classic and @docusaurus/theme-mermaid (#3080 )	2025-09-30 12:05:36 -07:00
package.json	chore(deps): bump webpack-dev-server, @docusaurus/core, @docusaurus/preset-classic and @docusaurus/theme-mermaid (#3080 )	2025-09-30 12:05:36 -07:00
sidebars.js	docs: Add a dedicated page on ZMK events (#2815 )	2025-08-18 23:45:16 +02:00
tsconfig.json	…
zmk-release-versions.json	docs: Add release version to the docs, with links and warning banner (#3122 )	2025-12-07 03:43:13 -05:00

Website

This website is built using Docusaurus 2, a modern static website generator.

License

The ZMK Documentation is licensed CC-BY-NC-SA.

$ npm ci

$ 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.

$ npm build

This command generates static content into the build directory and can be served using any static contents hosting service.