zmk/docs
Pete Johanson aa3e5dd70f
feat(display): Add config for display update period (#2819)
Add `CONFIG_ZMK_DISPLAY_TICK_PERIOD_MS` Kconfig to allow tweaking
the period between display updates.
2025-02-10 13:32:16 -05:00
..
blog docs: Move more sections under hardware integration (#2704) 2025-01-13 21:14:25 -08:00
docs feat(display): Add config for display update period (#2819) 2025-02-10 13:32:16 -05:00
src docs: Update intro page (#2767) 2025-01-22 16:58:15 -08:00
static docs: Move more sections under hardware integration (#2704) 2025-01-13 21:14:25 -08:00
.eslintignore
.eslintrc.js ci(docs): Disable eslint rule for unescaped entities 2024-01-20 22:28:41 -08:00
.gitignore
.nvmrc
.prettierignore
.prettierrc.js
README.md
docusaurus.config.js docs: Added mastodon link in footer 2024-10-17 15:01:30 -06:00
netlify-ignore-command.sh docs(ci): Netlify ignore command to check branch (#2659) 2024-11-18 20:26:26 -05:00
netlify.toml docs(ci): Netlify ignore command to check branch (#2659) 2024-11-18 20:26:26 -05:00
package-lock.json chore(deps): bump katex from 0.16.11 to 0.16.21 in /docs (#2774) 2025-01-17 15:15:54 -08:00
package.json chore(deps-dev): bump the development group across 1 directory with 7 updates (#2698) 2024-12-13 10:07:46 +01:00
sidebars.js docs: Move more sections under hardware integration (#2704) 2025-01-13 21:14:25 -08:00
tsconfig.json Update web-tree-sitter and tweak keymap upgrader (#2593) 2024-10-26 09:55:09 +02:00

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.