zmk/docs
Nick Coutsos 9d64c2a3a0 fix(docs): switch sensor rotate parameter order 2023-04-22 17:30:10 -07:00
..
blog fix(docs): Make link to keymap upgrader work. 2023-04-05 23:18:34 -07:00
docs fix(docs): switch sensor rotate parameter order 2023-04-22 17:30:10 -07:00
src refactor(behaviors): Rename `reset` behavior. 2023-04-05 22:55:38 -07:00
static
.eslintignore
.eslintrc.js
.gitignore Initial work on basic documentation. 2020-05-25 21:33:21 -04:00
.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 chore(deps): bump http-cache-semantics from 4.1.0 to 4.1.1 in /docs 2023-02-25 01:27:37 -05:00
package.json fix(docs): `npm start` to work from Docker. 2022-10-26 23:02:54 -05:00
sidebars.js feat(behaviors): Add reusable sensor behaviors. 2023-04-21 21:13:31 -07:00
tsconfig.json feat(docs): Add TOC to supported hardware page. 2022-04-19 07:05:26 -04: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.