Dom H c52887e236 fix(docs): Remove build.yml from new shield steps		3 years ago
..
blog	feat(docs): Add Zephyr 2.5 blog post.	3 years ago
docs	fix(docs): Remove build.yml from new shield steps	3 years ago
src	fix: Use correct Quotation marks on line 65 (#942 )	3 years ago
static	feat: Generate setup scripts from metadata.	3 years ago
.eslintignore	docs: Add eslint support	4 years ago
.eslintrc.js	fix(docs): Updated eslint config for unified prettier setup.	4 years ago
.gitignore	Initial work on basic documentation.	5 years ago
.nvmrc	docs: Set netlify node version to lts/*	4 years ago
.prettierignore	feat: Generate setup scripts from metadata.	3 years ago
.prettierrc.js	docs: Set prettier endOfLine to auto	4 years ago
README.md	fix(docs): Explicit CC-BY-NC-SA license for docs.	4 years ago
docusaurus.config.js	feat: Generate setup scripts from metadata.	3 years ago
netlify.toml	fix(docs): Deploy when boards/shields change.	3 years ago
package-lock.json	feat: Generate setup scripts from metadata.	3 years ago
package.json	feat: Generate setup scripts from metadata.	3 years ago
sidebars.js	docs: Add docs on hardware metadata files.	3 years ago
tsconfig.json	feat(docs): Type check the docs TSX components.	3 years ago

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.