mirror of https://github.com/zmkfirmware/zmk.git synced 2026-03-19 20:45:18 -05:00

Files

Nicolas Munnich e742da8e47 docs: Add new board guide (#3181 )

* docs: Add new board guide

* docs: apply feedback from review

2026-02-12 20:26:11 +01:00

blog

refactor(core): Adjust our approach for upstream Zephyr boards (#3145 )

2026-02-12 01:53:54 -05:00

docs

docs: Add new board guide (#3181 )

2026-02-12 20:26:11 +01: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

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: 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): bump lodash from 4.17.21 to 4.17.23 in /docs (#3211 )

2026-01-29 19:55:24 +01: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

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.