zmk/docs
dependabot[bot] 90363719a2
chore(deps): bump on-headers and compression in /docs (#2999)
---
updated-dependencies:
- dependency-name: on-headers
  dependency-version: 1.1.0
  dependency-type: indirect
- dependency-name: compression
  dependency-version: 1.8.1
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-08-04 22:32:36 +01:00
..
blog blog: Add blog post on pinning ZMK version (#2974) 2025-07-03 17:27:11 +02:00
docs docs: Updated putty link (#3020) 2025-08-04 13:16:38 +01:00
src chore(docs): Fix prettier warnings (#2952) 2025-06-01 12:02:39 -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
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 on-headers and compression in /docs (#2999) 2025-08-04 22:32:36 +01:00
package.json chore(deps): bump the docusaurus-minor-patch group across 1 directory with 3 updates (#2973) 2025-08-04 22:29:08 +01: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

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.