Jacob/zmk

Files

Peter Johanson 5e6634d2e5 feat(docs): Add TS type gen, metadata JSON gen

* Generate TS types from new hardware metadata schema.
* Aggregate all hw metadata YAML into one aggregate JSON
  file for consumption by others.

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

blog

feat(docs): Add Zephyr 2.5 blog post.

2021-07-17 17:04:25 -04:00

docs

fix typo

2021-08-12 19:14:44 -05:00

src

feat(docs): Add TS type gen, metadata JSON gen

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

static

fix: Add semicolons for tidbit and eek in setup script

2021-09-03 23:11:05 -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

docs: Add prettier support

2020-10-25 21:24:55 +00:00

.prettierrc.js

docs: Set prettier endOfLine to auto

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

docusaurus.config.js

feat(docs): Add TS type gen, metadata JSON gen

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

netlify.toml

fix(docs): Add permanent redict to zmk.dev domain.

2021-06-10 10:06:41 -04:00

package-lock.json

feat(docs): Add TS type gen, metadata JSON gen

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

package.json

feat(docs): Add TS type gen, metadata JSON gen

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

README.md

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

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

sidebars.js

Docs: added mod morph page (#749 )

2021-04-05 18:04:38 -05:00

tsconfig.json

feat(docs): Add TS type gen, metadata JSON gen

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.