kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
zmk/docs
History
innovaker 175d3d8abd docs(docs/codes): Add comments of primary code names to hid's os data 
This should make GitHub PR reviews easier because GitHub's change summaries do not currently include sufficient context without lots of digging.

Changes made with a RegExp Replace:
Find: (names: \[")([\w\d_]+?)("[^	]+?os: \{)
Replacement: $1$2$3 // $2
2020-11-17 21:02:59 +00:00
..
blog refactor(docs): Change behavior to behaviors 2020-11-16 15:33:44 -05:00
docs docs: Fix typo in PowerShell install script 2020-11-17 20:56:27 +00:00
src docs(docs/codes): Add comments of primary code names to hid's os data 2020-11-17 21:02:59 +00:00
static Jian shield 2020-11-17 16:23:39 +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 docs(codes): Add (key) codes documentation 2020-11-06 15:02:12 -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): Change behavior to behaviors 2020-11-16 15:33:44 -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.