History

Pete Johanson acfd8e5ea7 docs: Build fix on release branches (#3130 ) Small build fix for the navbar label for the version dropdown, when building in release version branches.		2025-12-07 02:05:16 -07:00
..
blog	blog: Add blog post on pinning ZMK version (#2974 )	2025-07-03 17:27:11 +02:00
docs	fix(split): Enable wired split by default if DTS is set (#3010 )	2025-07-30 13:43:46 -04:00
src	docs: Add release version to the docs, with links and warning banner (#3122 )	2025-12-07 01:43:49 -07:00
static	docs: Update hold-tap page (#2888 )	2025-03-23 18:12:50 -07:00
.gitignore	…
.nvmrc	…
.prettierignore	chore: Add typescript support to eslint, fix errors (#2923 )	2025-04-22 20:51:41 -07:00
.prettierrc.js	chore: Add typescript support to eslint, fix errors (#2923 )	2025-04-22 20:51:41 -07:00
README.md	…
docusaurus.config.js	docs: Build fix on release branches (#3130 )	2025-12-07 02:05:16 -07:00
eslint.config.mjs	chore: Add typescript support to eslint, fix errors (#2923 )	2025-04-22 20:51:41 -07:00
netlify-ignore-command.sh	docs(ci): Netlify ignore command to check branch (#2659 )	2024-11-18 20:26:26 -05:00
netlify.toml	docs(ci): Netlify ignore command to check branch (#2659 )	2024-11-18 20:26:26 -05:00
package-lock.json	chore(deps): bump the docusaurus-minor-patch group (#2948 )	2025-06-01 23:21:14 -07:00
package.json	chore(deps): bump the docusaurus-minor-patch group (#2948 )	2025-06-01 23:21:14 -07:00
sidebars.js	docs: Update hold-tap page (#2888 )	2025-03-23 18:12:50 -07:00
tsconfig.json	chore: Add typescript support to eslint, fix errors (#2923 )	2025-04-22 20:51:41 -07:00
zmk-release-versions.json	docs: Add release version to the docs, with links and warning banner (#3122 )	2025-12-07 01:43:49 -07:00

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.