zmk/docs
Cem Aksoylar 022ede9d1e docs: Remove download for settings_reset and note local build 2024-10-08 17:04:36 -07:00
..
blog blog: Remove reference to spaceman (#2520) 2024-09-30 19:43:58 -07:00
docs docs: Remove download for settings_reset and note local build 2024-10-08 17:04:36 -07:00
src refactor(docs): Convert the keymaps section into a base folder (#2430) 2024-08-21 10:39:18 -07:00
static refactor(docs): Refactor the development section (#2438) 2024-09-01 21:54:19 -07:00
.eslintignore
.eslintrc.js
.gitignore
.nvmrc
.prettierignore
.prettierrc.js
README.md
docusaurus.config.js refactor(docs): Refactor the development section (#2438) 2024-09-01 21:54:19 -07:00
netlify.toml
package-lock.json chore(deps): bump web-tree-sitter from 0.20.8 to 0.23.0 in /docs 2024-09-01 22:57:37 -07:00
package.json chore(deps): bump web-tree-sitter from 0.20.8 to 0.23.0 in /docs 2024-09-01 22:57:37 -07:00
sidebars.js docs: Pull encoders from new shield guide to its own page (#2510) 2024-09-30 10:06:00 -07:00
tsconfig.json

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.