zmk/docs
Nick Conway 535be545a6
satisfy pre-commit checks
2025-12-12 11:18:20 -05:00
..
blog blog: Clarify west upgrade command in Zephyr 4.1 update post (#3133) 2025-12-11 21:08:03 -08:00
docs satisfy pre-commit checks 2025-12-12 11:18:20 -05:00
src docs: Add release version to the docs, with links and warning banner (#3122) 2025-12-07 03:43:13 -05:00
static
.gitignore
.nvmrc
.prettierignore
.prettierrc.js
README.md
docusaurus.config.js docs: Build fix on release branches (#3130) 2025-12-07 04:04:51 -05:00
eslint.config.mjs
netlify-ignore-command.sh
netlify.toml
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 Update for 3.5 and refactor 2025-12-12 11:18:20 -05:00
tsconfig.json
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.