zmk/docs
LostQuasar 90d6285d98
blog: Remove reference to spaceman (#2520)
2024-09-30 19:43:58 -07:00
..
blog blog: Remove reference to spaceman (#2520) 2024-09-30 19:43:58 -07:00
docs docs: fixed broken anchors 2024-09-30 16:43:47 -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 ci(docs): Disable eslint rule for unescaped entities 2024-01-20 22:28:41 -08:00
.gitignore
.nvmrc
.prettierignore
.prettierrc.js
README.md docs: Add syntax highlighting to more code blocks 2023-10-09 15:19:24 -07:00
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 feat(keymap-upgrader): Upgrade renamed nodes 2024-01-25 18:03:37 -06: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.