Jacob/zmk

Files

Seth Milliken 51503629c7 feat(docs): add new recipes section

Recipes document distinct functionality provided by novel use of
existing config, features, and behaviors.

n.b. All pages are currently only placeholders. All names are tentative.

2023-10-04 21:51:54 -07:00

blog

feat(blog): Add post about sensor refactor.

2023-06-18 20:45:06 -06:00

docs

feat(docs): add new recipes section

2023-10-04 21:51:54 -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

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

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 @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

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

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

sidebars.js

feat(docs): add new recipes section

2023-10-04 21:51:54 -07:00

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.