zmk/docs
Albert Y 48be2eedd0 fix(docs): Update QMK debounce references 2023-05-09 21:40:14 -07:00
..
blog refactor: Replace tabs with spaces 2023-04-24 16:07:04 -07:00
docs fix(docs): Update QMK debounce references 2023-05-09 21:40:14 -07:00
src fix(docs): Add key to interconnect tabs 2023-04-25 15:50:38 -07:00
static
.eslintignore
.eslintrc.js
.gitignore
.nvmrc
.prettierignore
.prettierrc.js
README.md
docusaurus.config.js
netlify.toml
package-lock.json chore: Update Prettier 2023-04-24 16:07:04 -07:00
package.json chore: Update Prettier 2023-04-24 16:07:04 -07:00
sidebars.js docs: Add pre-commit documentation 2023-04-24 16:07:04 -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.