History

dependabot[bot] fe12e7a801 chore(deps-dev): bump flatted from 3.3.3 to 3.4.2 in /docs Bumps [flatted](https://github.com/WebReflection/flatted) from 3.3.3 to 3.4.2. - [Commits](https://github.com/WebReflection/flatted/compare/v3.3.3...v3.4.2) --- updated-dependencies: - dependency-name: flatted dependency-version: 3.4.2 dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com>		2026-03-20 17:59:23 +00:00
..
blog	docs: Fix up board IDs in the Zephyr 4.1 blog post to add ZMK variant (#3247 )	2026-02-17 23:06:45 -08:00
docs	docs: Fix #import to #include in dongle docs (#3276 )	2026-03-05 15:38:51 -08:00
src	docs: Update Linux compatibility of C_AC_NEXT_KEYBOARD_LAYOUT_SELECT (#3268 )	2026-03-02 11:39:08 -08:00
static	docs: Add redirect setup script informing users to switch to ZMK CLI (#3168 )	2025-12-29 10:26:00 -08:00
.gitignore	…
.nvmrc	…
.prettierignore	…
.prettierrc.js	…
README.md	…
docusaurus.config.js	docs: Replace user setup script with ZMK CLI (#3137 )	2025-12-14 16:20:35 -06:00
eslint.config.mjs	…
netlify-ignore-command.sh	…
netlify.toml	…
package-lock.json	chore(deps-dev): bump flatted from 3.3.3 to 3.4.2 in /docs	2026-03-20 17:59:23 +00:00
package.json	chore(deps-dev): bump typescript-eslint (#3192 )	2026-01-07 23:22:33 +01:00
sidebars.js	docs: Add new board guide (#3181 )	2026-02-12 20:26:11 +01: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.