zmk/docs
dependabot[bot] d0d041e3cd
chore(deps): bump lodash-es and langium in /docs (#3322)
Bumps [lodash-es](https://github.com/lodash/lodash) and [langium](https://github.com/eclipse-langium/langium/tree/HEAD/packages/langium). These dependencies needed to be updated together.

Updates `lodash-es` from 4.17.23 to 4.18.1
- [Release notes](https://github.com/lodash/lodash/releases)
- [Commits](https://github.com/lodash/lodash/compare/4.17.23...4.18.1)

Updates `langium` from 4.2.1 to 4.2.4
- [Release notes](https://github.com/eclipse-langium/langium/releases)
- [Changelog](https://github.com/eclipse-langium/langium/blob/main/packages/langium/CHANGELOG.md)
- [Commits](https://github.com/eclipse-langium/langium/commits/v4.2.4/packages/langium)

---
updated-dependencies:
- dependency-name: langium
  dependency-version: 4.2.2
  dependency-type: indirect
- dependency-name: lodash-es
  dependency-version: 4.18.1
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-05-23 11:33:38 +02: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 wrappping -> wrapping typo in sticky-key docs (#3340) 2026-05-04 19:23:34 +02:00
src docs: Clarify how PIPE2 and TILDE2 differ from regular variants (#3310) 2026-03-29 13:25:29 -07:00
static docs: Add redirect setup script informing users to switch to ZMK CLI (#3168) 2025-12-29 10:26:00 -08:00
.gitignore Initial work on basic documentation. 2020-05-25 21:33:21 -04:00
.nvmrc docs: Set netlify node version to lts/* 2020-10-26 22:55:15 +00:00
.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
docusaurus.config.js docs: Remove ZMK Twitter (#3337) 2026-04-30 10:15:20 -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 lodash-es and langium in /docs (#3322) 2026-05-23 11:33:38 +02:00
package.json chore(deps-dev): bump typescript-eslint (#3192) 2026-01-07 23:22:33 +01:00
README.md docs: Add syntax highlighting to more code blocks 2023-10-09 15:19:24 -07:00
sidebars.js feat: Add LED indicator support (#3239) 2026-03-23 02:35:35 -04: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

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.