zmk/docs
Genteure 7823a43f62
docs: fix path typo in module-creation.md (#2920)
2025-04-16 09:53:56 -07:00
..
blog blog: Add meeting notes from February (#2890) 2025-03-25 19:20:50 +01:00
docs docs: fix path typo in module-creation.md (#2920) 2025-04-16 09:53:56 -07:00
src chore(eslint): upgrade to eslint v9 and flat config (#2909) 2025-04-06 18:16:03 -07:00
static docs: Update hold-tap page (#2888) 2025-03-23 18:12:50 -07:00
.gitignore
.nvmrc
.prettierignore
.prettierrc.js
README.md
docusaurus.config.js docs: Added mastodon link in footer 2024-10-17 15:01:30 -06:00
eslint.config.mjs chore(eslint): upgrade to eslint v9 and flat config (#2909) 2025-04-06 18:16:03 -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 estree-util-value-to-estree in /docs (#2914) 2025-04-07 21:54:32 -07:00
package.json chore(eslint): upgrade to eslint v9 and flat config (#2909) 2025-04-06 18:16:03 -07:00
sidebars.js docs: Update hold-tap page (#2888) 2025-03-23 18:12:50 -07:00
tsconfig.json Update web-tree-sitter and tweak keymap upgrader (#2593) 2024-10-26 09:55:09 +02: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.