Jacob/zmk

forked from kofal.net/zmk

Files

History

Cem Aksoylar 5c4f26ae74 fix(docs): Tweak label of left-hand positional hold-tap example behavior

We see folks copying this behavior node and duplicating it for the right hand,
then forgetting to modify the "label" value and getting confusing runtime
behavior. If we modify the label to be left-specific like this it might be
a better hint to change it when duplicating it.

2022-02-12 07:09:58 +00:00

..

feat(docs): add backlight documentation

2022-02-05 23:40:18 -05:00

fix(docs): Tweak label of left-hand positional hold-tap example behavior

2022-02-12 07:09:58 +00:00

feat(docs): add backlight to power profiler

2022-02-05 23:40:18 -05:00

feat: Generate setup scripts from metadata.

2021-09-11 00:50:36 -04:00

.eslintignore

docs: Add eslint support

2020-10-25 21:23:16 +00:00

.eslintrc.js

fix(docs): Updated eslint config for unified prettier setup.

2021-05-05 00:54:55 -04:00

.gitignore

Initial work on basic documentation.

2020-05-25 21:33:21 -04:00

.nvmrc

docs: Set netlify node version to lts/*

2020-10-26 22:55:15 +00:00

.prettierignore

feat: Generate setup scripts from metadata.

2021-09-11 00:50:36 -04:00

.prettierrc.js

docs: Set prettier endOfLine to auto

2020-10-26 05:28:31 +00:00

docusaurus.config.js

feat: Generate setup scripts from metadata.

2021-09-11 00:50:36 -04:00

netlify.toml

fix(docs): Deploy when boards/shields change.

2021-09-11 00:50:36 -04:00

package-lock.json

chore(deps-dev): bump json-schema-to-typescript in /docs

2022-02-05 23:31:00 -05:00

package.json

chore(deps-dev): bump json-schema-to-typescript in /docs

2022-02-05 23:31:00 -05:00

README.md

fix(docs): Explicit CC-BY-NC-SA license for docs.

2020-10-26 23:15:48 -04:00

sidebars.js

feat(docs): add backlight documentation

2022-02-05 23:40:18 -05:00

tsconfig.json

feat(docs): Type check the docs TSX components.

2021-09-11 00:50:36 -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.