zmkfirmware
/
zmk
mirror of https://github.com/zmkfirmware/zmk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
zmk/docs
History
Peter Johanson 3099de4e2a docs: Add a note about using CMake v3 for maximum compatibility. 
Some optional modules, like libmetal, which is used on nRF5340,
specfically require CMake v3, so add a note in the native toolchain
setup about this.
 		2025-11-19 23:56:35 -07:00
..
blog docs: Add bootloader integrtion page 2025-11-19 23:56:35 -07:00
docs docs: Add a note about using CMake v3 for maximum compatibility. 2025-11-19 23:56:35 -07:00
src docs: K_VOLUME_UP and K_VOLUME_DOWN work in macOS (#3057) 2025-09-12 14:08:17 +01: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 docs: Add syntax highlighting to more code blocks 2023-10-09 15:19:24 -07:00
docusaurus.config.js docs: Added mastodon link in footer 2024-10-17 15:01:30 -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 webpack-dev-server, @docusaurus/core, @docusaurus/preset-classic and @docusaurus/theme-mermaid (#3080) 2025-09-30 12:05:36 -07:00
package.json chore(deps): bump webpack-dev-server, @docusaurus/core, @docusaurus/preset-classic and @docusaurus/theme-mermaid (#3080) 2025-09-30 12:05:36 -07:00
sidebars.js docs: Add bootloader integrtion page 2025-11-19 23:56:35 -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.