zmk/docs
Brian Tannous 644fc821f7
Set C_AL_CALC for macOS and iOS to false (#1595)
2024-11-03 01:25:48 +01:00
..
blog blog: Remove reference to spaceman (#2520) 2024-09-30 19:43:58 -07:00
docs docs(feat): further generalize RGB information (#2485) 2024-11-03 00:31:15 +01:00
src Set C_AL_CALC for macOS and iOS to false (#1595) 2024-11-03 01:25:48 +01:00
static Update web-tree-sitter and tweak keymap upgrader (#2593) 2024-10-26 09:55:09 +02:00
.eslintignore
.eslintrc.js ci(docs): Disable eslint rule for unescaped entities 2024-01-20 22:28:41 -08:00
.gitignore
.nvmrc
.prettierignore feat: Generate setup scripts from metadata. 2021-09-11 00:50:36 -04:00
.prettierrc.js
README.md docs: Add syntax highlighting to more code blocks 2023-10-09 15:19:24 -07:00
docusaurus.config.js docs: Added mastodon link in footer 2024-10-17 15:01:30 -06:00
netlify.toml fix(docs): Allow CORS for hardware-metadata.json 2022-03-30 07:13:13 -04:00
package-lock.json chore(deps-dev): bump webpack from 5.95.0 to 5.96.0 in /docs (#2600) 2024-11-01 09:50:53 +01:00
package.json chore(deps-dev): bump webpack from 5.95.0 to 5.96.0 in /docs (#2600) 2024-11-01 09:50:53 +01:00
sidebars.js feat(docs) Adding some additional clarity around low power states (#2330) 2024-11-02 23:20:31 +01: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.