kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
zmk/docs
History
Harry Herring d788236304 Revert "Update setup.ps1" 
This reverts commit 7a359a55d0.
2020-12-01 19:20:35 +00:00
..
blog Oh god what have i done 2020-12-01 19:11:00 +00:00
docs Oh god what have i done 2020-12-01 19:11:00 +00:00
src Oh god what have i done 2020-12-01 19:11:00 +00:00
static Revert "Update setup.ps1" 2020-12-01 19:20:35 +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 Oh god what have i done 2020-12-01 19:11:00 +00: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 Oh god what have i done 2020-12-01 19:11:00 +00: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.