You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Peter Johanson f03e29ca13 fix(config): Fix split wired detection in setup.sh. 4 months ago
..
blog feat(blog): Add second birthday post. 11 months ago
docs feat(boards): Add PillBug board, blackpill interconnect. 4 months ago
src fix(config): Fix split wired detection in setup.sh. 4 months ago
static feat: Generate setup scripts from metadata. 2 years ago
.eslintignore docs: Add eslint support 2 years ago
.eslintrc.js fix(docs): Updated eslint config for unified prettier setup. 2 years ago
.gitignore Initial work on basic documentation. 3 years ago
.nvmrc docs: Set netlify node version to lts/* 2 years ago
.prettierignore feat: Generate setup scripts from metadata. 2 years ago
.prettierrc.js docs: Set prettier endOfLine to auto 2 years ago
README.md fix(docs): Explicit CC-BY-NC-SA license for docs. 2 years ago
docusaurus.config.js fix(docs): Standardize URLs with no trailing slash 10 months ago
netlify.toml fix(docs): Allow CORS for hardware-metadata.json 1 year ago
package-lock.json chore(deps): bump loader-utils from 2.0.3 to 2.0.4 in /docs 4 months ago
package.json fix(docs): `npm start` to work from Docker. 5 months ago
sidebars.js feat(docs): Update power and lighting config pages 9 months ago
tsconfig.json feat(docs): Add TOC to supported hardware page. 11 months ago

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.