michi/zmk

mirror of https://github.com/zmkfirmware/zmk.git synced 2026-04-29 19:13:26 +02:00

Files

T

onebigdoor 4c92a4e50f docs(codes): improve macOS support data

Tested with Karabiner-EventViewer as well as some manual checks.

PR: #377
See: #375

2020-12-09 13:58:24 +00:00

blog

refactor(docs): Change behavior to behaviors

2020-11-16 15:33:44 -05:00

docs

docs(codes): improve macOS support data

2020-12-09 13:58:24 +00:00

src

docs(codes): improve macOS support data

2020-12-09 13:58:24 +00:00

static

feat(shields): add CRBN shield

2020-12-07 16:49:37 +00:00

.eslintignore

docs: Add eslint support

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

.eslintrc.js

docs: Add eslint-mdx support

2020-10-25 21:25:01 +00: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

refactor(docs): Move dev- documents into /development

2020-11-20 22:31:56 -05:00

netlify.toml

Move the netlify.toml file into docs/

2020-07-03 10:43:27 -04:00

package-lock.json

docs(codes): Add (key) codes documentation

2020-11-06 15:02:12 -05:00

package.json

docs(codes): Add (key) codes documentation

2020-11-06 15:02:12 -05:00

README.md

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

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

sidebars.js

refactor(docs): Integrate Dev Guides into Development section

2020-11-20 22:31:56 -05: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.