zmkfirmware
/
zmk
mirror of https://github.com/zmkfirmware/zmk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
zmk/docs
History
dependabot[bot] c78b580438
chore(deps-dev): bump the development group across 1 directory with 4 updates 
Bumps the development group with 4 updates in the /docs directory: [eslint-plugin-mdx](https://github.com/mdx-js/eslint-mdx), [prettier](https://github.com/prettier/prettier), [typescript-eslint](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/typescript-eslint) and [webpack](https://github.com/webpack/webpack).


Updates `eslint-plugin-mdx` from 3.6.2 to 3.7.0
- [Release notes](https://github.com/mdx-js/eslint-mdx/releases)
- [Changelog](https://github.com/mdx-js/eslint-mdx/blob/master/CHANGELOG.md)
- [Commits](https://github.com/mdx-js/eslint-mdx/compare/eslint-plugin-mdx@3.6.2...eslint-plugin-mdx@3.7.0)

Updates `prettier` from 3.7.4 to 3.8.1
- [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.1)

Updates `typescript-eslint` from 8.52.0 to 8.56.1
- [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.56.1/packages/typescript-eslint)

Updates `webpack` from 5.104.1 to 5.105.3
- [Release notes](https://github.com/webpack/webpack/releases)
- [Changelog](https://github.com/webpack/webpack/blob/main/CHANGELOG.md)
- [Commits](https://github.com/webpack/webpack/compare/v5.104.1...v5.105.3)

---
updated-dependencies:
- dependency-name: eslint-plugin-mdx
  dependency-version: 3.7.0
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: development
- dependency-name: prettier
  dependency-version: 3.8.1
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: development
- dependency-name: typescript-eslint
  dependency-version: 8.56.1
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: development
- dependency-name: webpack
  dependency-version: 5.105.3
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: development
...

Signed-off-by: dependabot[bot] <support@github.com>
 		2026-03-20 05:03:34 +00: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 #import to #include in dongle docs (#3276) 2026-03-05 15:38:51 -08:00
src docs: Update Linux compatibility of C_AC_NEXT_KEYBOARD_LAYOUT_SELECT (#3268) 2026-03-02 11:39:08 -08: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 4 updates 2026-03-20 05:03:34 +00:00
package.json chore(deps-dev): bump the development group across 1 directory with 4 updates 2026-03-20 05:03:34 +00:00
sidebars.js docs: Add new board guide (#3181) 2026-02-12 20:26:11 +01: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.