zmk/docs
Horu 7d1f84e3eb
chore: fix typos in various places
2024-05-13 16:47:33 -04:00
..
blog chore: fix typos in various places 2024-05-13 16:47:33 -04:00
docs chore: fix typos in various places 2024-05-13 16:47:33 -04:00
src chore: fix typos in various places 2024-05-13 16:47:33 -04:00
static chore(docs): Update tree-sitter-devicetree to 0.9.0 2024-01-25 18:03:37 -06: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: Improve keymap upgrader 2024-01-25 18:03:37 -06:00
netlify.toml
package-lock.json chore(deps): bump react-toastify from 7.0.4 to 10.0.5 in /docs 2024-03-28 10:41:56 -07:00
package.json chore(deps): bump react-toastify from 7.0.4 to 10.0.5 in /docs 2024-03-28 10:41:56 -07:00
sidebars.js feat: Add soft on/off support. 2024-03-27 20:59:26 -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.