History

Nick Conway 2359b5b2f4 Merge `6ae088c36f` into `abb64ba316`		2025-12-07 11:06:16 -08:00
..
blog	docs: Add warning box for clearing settings for splits, generalize troubleshooting procedure (#3039 )	2025-08-19 17:27:21 -07:00
docs	Merge `6ae088c36f` into `abb64ba316`	2025-12-07 11:06:16 -08:00
src	docs: Add release version to the docs, with links and warning banner (#3122 )	2025-12-07 03:43:13 -05: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 04:04:51 -05: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 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	Merge `6ae088c36f` into `abb64ba316`	2025-12-07 11:06:16 -08: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 03:43:13 -05: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.