History

Joel Spadin ed41d42874 feat(docs): Add aggregated metadata to website Added /hardware-metadata.json to the ZMK website. This gives external tools a way to grab all hardware metadata at once.		2022-03-29 23:03:56 -04:00
..
blog	feat: Add blog post with Zephyr 3.0 prep.	2022-03-08 14:14:15 -05:00
docs	fix(docs): Fix Windows unicode macro example	2022-03-28 21:16:48 -04:00
src	feat(docs): Add aggregated metadata to website	2022-03-29 23:03:56 -04:00
static	feat: Generate setup scripts from metadata.	2021-09-11 00:50:36 -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	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	feat(docs): Add aggregated metadata to website	2022-03-29 23:03:56 -04:00
netlify.toml	fix(docs): Deploy when boards/shields change.	2021-09-11 00:50:36 -04:00
package-lock.json	feat(docs): Add aggregated metadata to website	2022-03-29 23:03:56 -04:00
package.json	feat(docs): Add aggregated metadata to website	2022-03-29 23:03:56 -04: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): Document the macro behavior.	2022-03-23 23:42:54 -04:00
tsconfig.json	feat(docs): Type check the docs TSX components.	2021-09-11 00:50:36 -04: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.