History

Joel Spadin 0325fe9a18 docs: Switch back to package version 2 package-lock.json was rewritten to version 1 in `13dbbefcb4`.		2021-07-24 13:12:54 -05:00
..
blog	feat(docs): Add Zephyr 2.5 blog post.	2021-07-17 17:04:25 -04:00
docs	docs(setup): replace `zephyr-west-action` with `zmk-docker`	2021-07-18 03:52:45 +01:00
src	feat(docs): Add nice!nano v2 to scripts, actions, and documentation	2021-07-15 18:52:28 -04:00
static	fix: Add missing semicolon for nano V2 case.	2021-07-21 22:06:32 -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	refactor: Move to new zmk.dev domain name.	2021-06-10 09:27:57 -04:00
netlify.toml	fix(docs): Add permanent redict to zmk.dev domain.	2021-06-10 10:06:41 -04:00
package-lock.json	docs: Switch back to package version 2	2021-07-24 13:12:54 -05:00
package.json	chore(deps): bump @docusaurus/* to 2.0.0-beta.3	2021-07-17 22:10: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

Website

This website is built using Docusaurus 2, a modern static website generator.

License

The ZMK Documentation is licensed CC-BY-NC-SA.

$ npm ci

$ 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.

$ npm build

This command generates static content into the build directory and can be served using any static contents hosting service.