zmk/docs
Seth Milliken c957348e61 fix(docs): detail overriding the led_strip chain-length property
Quite a few people have struggled with setting the correct
`chain-length` for their `led_strip`. For some, this is their first time
needing to change a pre-defined devicetree property, and so they aren't
familiar with the technique. I commonly see folks adding a duplicate of
the entire `*.overlay` file with only the `chain-length` value changed.
Having clear documentation for this specific application of the property
override technique could help forestall these problems, and give those
of us helping out in Discord something to easily reference.
2023-08-15 11:04:01 +03:00
..
blog feat(blog): Add post about sensor refactor. 2023-06-18 20:45:06 -06:00
docs fix(docs): detail overriding the led_strip chain-length property 2023-08-15 11:04:01 +03:00
src fix(docs): Fix INT6 keycode description 2023-06-10 12:32:50 -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 fix(docs): Standardize URLs with no trailing slash 2022-05-23 10:09:53 -04: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 semver from 5.7.1 to 5.7.2 in /docs 2023-07-20 09:52:20 -07:00
package.json chore(deps-dev): bump webpack from 5.80.0 to 5.86.0 in /docs 2023-06-10 23:51:23 -07:00
README.md fix(docs): Explicit CC-BY-NC-SA license for docs. 2020-10-26 23:15:48 -04: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.

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.