History

Albert Y 2ad8f687c0 docs: Add a note for GitHub SSH scheme (#1089 ) Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>		2022-01-13 09:23:43 +00:00
..
blog	…
docs	docs: Add a note for GitHub SSH scheme (#1089 )	2022-01-13 09:23:43 +00:00
src	docs(codes): Windows Support: Media Controls	2022-01-02 10:44:55 +00:00
static	feat: Generate setup scripts from metadata.	2021-09-11 00:50:36 -04:00
.eslintignore	…
.eslintrc.js	…
.gitignore	…
.nvmrc	…
.prettierignore	feat: Generate setup scripts from metadata.	2021-09-11 00:50:36 -04:00
.prettierrc.js	…
README.md	…
docusaurus.config.js	feat: Generate setup scripts from metadata.	2021-09-11 00:50:36 -04:00
netlify.toml	fix(docs): Deploy when boards/shields change.	2021-09-11 00:50:36 -04:00
package-lock.json	chore(deps): bump @fortawesome/react-fontawesome in /docs	2021-10-20 22:56:45 -04:00
package.json	chore(deps): bump @fortawesome/react-fontawesome in /docs	2021-10-20 22:56:45 -04:00
sidebars.js	feat(behaviors): Add caps word (`&caps_word`).	2021-11-28 22:41:35 -05:00
tsconfig.json	feat(docs): Type check the docs TSX components.	2021-09-11 00:50:36 -04: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.