History

Cem Aksoylar 7b4b5d4ff2 fix(docs): Fix debouncing driver support note		2023-11-13 12:37:09 -08:00
..
blog	feat(blog): Add keymap editor post for spotlight series	2023-11-08 23:00:26 -08:00
docs	fix(docs): Fix debouncing driver support note	2023-11-13 12:37:09 -08:00
src	feat(docs): Document globe key specific quirks	2023-10-10 14:04:28 -07:00
static	docs: Update tree-sitter	2023-05-20 01:33:11 -06: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(blog): Show all posts on sidebar	2023-11-08 23:00:26 -08:00
netlify.toml	fix(docs): Allow CORS for hardware-metadata.json	2022-03-30 07:13:13 -04:00
package-lock.json	chore(deps): bump postcss from 8.4.18 to 8.4.31 in /docs	2023-10-10 16:17:44 -07:00
package.json	chore(deps): bump @fortawesome/fontawesome-svg-core in /docs	2023-09-04 23:20:33 -07:00
README.md	docs: Add syntax highlighting to more code blocks	2023-10-09 15:19:24 -07:00
sidebars.js	docs: Add pre-commit documentation	2023-04-24 16:07:04 -07:00
tsconfig.json	fix(docs): Fix typescript error	2023-05-20 01:33:11 -06: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.