zmk/docs
Joel Spadin c4c014e3d1 fix(docs): Fix typescript error
See https://github.com/facebook/docusaurus/issues/8226#issuecomment-1420620198
2023-05-20 01:33:11 -06: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 docs: Update tree-sitter 2023-05-20 01:33:11 -06:00
static docs: Update tree-sitter 2023-05-20 01:33:11 -06:00
.eslintignore
.eslintrc.js fix(docs): Updated eslint config for unified prettier setup. 2021-05-05 00:54:55 -04:00
.gitignore
.nvmrc
.prettierignore feat: Generate setup scripts from metadata. 2021-09-11 00:50:36 -04:00
.prettierrc.js
README.md
docusaurus.config.js fix(docs): Standardize URLs with no trailing slash 2022-05-23 10:09:53 -04:00
netlify.toml fix(docs): Allow CORS for hardware-metadata.json 2022-03-30 07:13:13 -04:00
package-lock.json docs: Update tree-sitter 2023-05-20 01:33:11 -06:00
package.json docs: Update tree-sitter 2023-05-20 01:33:11 -06:00
sidebars.js docs: Add pre-commit documentation 2023-04-24 16:07:04 -07:00
tsconfig.json fix(docs): Fix typescript error 2023-05-20 01:33:11 -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.