zmk/docs
Cem Aksoylar 8b71ca1e81 Apply suggestions from code review
Co-authored-by: Pete Johanson <peter@peterjohanson.com>
2023-10-05 00:05:13 -07:00
..
blog Apply suggestions from code review 2023-10-05 00:05:13 -07:00
docs feat(docs): Add configuration snippet for layer-taps 2023-10-04 13:29:06 -07:00
src feat(hid): Add apple globe keycode 2023-09-29 13:14:31 -07:00
static docs: Update tree-sitter 2023-05-20 01:33:11 -06:00
.eslintignore
.eslintrc.js
.gitignore
.nvmrc
.prettierignore
.prettierrc.js
docusaurus.config.js fix(docs): Standardize URLs with no trailing slash 2022-05-23 10:09:53 -04:00
netlify.toml
package-lock.json chore(deps): bump @fortawesome/fontawesome-svg-core in /docs 2023-09-04 23:20:33 -07:00
package.json chore(deps): bump @fortawesome/fontawesome-svg-core in /docs 2023-09-04 23:20:33 -07:00
README.md
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

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.