zmk/docs
dependabot[bot] 7e6494732d
chore(deps-dev): bump the development group across 1 directory with 2 updates
Bumps the development group with 2 updates in the /docs directory: [prettier](https://github.com/prettier/prettier) and [typescript-eslint](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/typescript-eslint).


Updates `prettier` from 3.7.4 to 3.8.0
- [Release notes](https://github.com/prettier/prettier/releases)
- [Changelog](https://github.com/prettier/prettier/blob/main/CHANGELOG.md)
- [Commits](https://github.com/prettier/prettier/compare/3.7.4...3.8.0)

Updates `typescript-eslint` from 8.52.0 to 8.53.0
- [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases)
- [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/typescript-eslint/CHANGELOG.md)
- [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v8.53.0/packages/typescript-eslint)

---
updated-dependencies:
- dependency-name: prettier
  dependency-version: 3.8.0
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: development
- dependency-name: typescript-eslint
  dependency-version: 8.53.0
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: development
...

Signed-off-by: dependabot[bot] <support@github.com>
2026-01-30 05:03:16 +00:00
..
blog docs: Update Corne-ish Zen mentions for Zephyr 4.1 upgrade renames (#3143) 2025-12-14 07:15:54 +00:00
docs fix(docs): Improve ZMK setup instructions (#3209) 2026-01-17 20:00:01 -06:00
src fix(docs): Improve ZMK setup instructions (#3209) 2026-01-17 20:00:01 -06: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 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 docs: Add syntax highlighting to more code blocks 2023-10-09 15:19:24 -07:00
docusaurus.config.js docs: Replace user setup script with ZMK CLI (#3137) 2025-12-14 16:20:35 -06: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-dev): bump the development group across 1 directory with 2 updates 2026-01-30 05:03:16 +00:00
package.json chore(deps-dev): bump the development group across 1 directory with 2 updates 2026-01-30 05:03:16 +00:00
sidebars.js SoC: stm32c0 support (#3174) 2026-01-07 18:05:13 -05: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.