zmk/docs
ReFil 6c75d6986c feat(docs): Document globe key specific quirks 2023-10-10 14:04:28 -07:00
..
blog docs: Add syntax highlighting to more code blocks 2023-10-09 15:19:24 -07:00
docs feat(docs): Document globe key specific quirks 2023-10-10 14:04:28 -07:00
src feat(docs): Document globe key specific quirks 2023-10-10 14:04:28 -07:00
static
.eslintignore
.eslintrc.js
.gitignore
.nvmrc
.prettierignore feat: Generate setup scripts from metadata. 2021-09-11 00:50:36 -04:00
.prettierrc.js
README.md docs: Add syntax highlighting to more code blocks 2023-10-09 15:19:24 -07:00
docusaurus.config.js docs: Add highlighting for devicetree and kconfig 2023-10-09 15:19:24 -07: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
sidebars.js
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.