zmk/docs
Nicolas Munnich 503f6c8e58
feat(docs): Add and modify docs to point users to the experimental zmk-cli (#2431)
Co-authored-by: Joel Spadin <joelspadin@gmail.com>
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2024-08-21 10:36:23 -07:00
..
blog refactor(docs): Split up troubleshooting page into a section 2024-06-17 11:46:32 -07:00
docs feat(docs): Add and modify docs to point users to the experimental zmk-cli (#2431) 2024-08-21 10:36:23 -07:00
src feat(studio): Initial RPC infrastructure and subsystems. 2024-08-15 11:45:18 -06:00
static chore(docs): Update tree-sitter-devicetree to 0.9.0 2024-01-25 18:03:37 -06: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 feat(studio): Initial RPC infrastructure and subsystems. 2024-08-15 11:45:18 -06:00
netlify.toml
package-lock.json feat(studio): Initial RPC infrastructure and subsystems. 2024-08-15 11:45:18 -06:00
package.json feat(studio): Initial RPC infrastructure and subsystems. 2024-08-15 11:45:18 -06:00
sidebars.js feat(studio): Initial RPC infrastructure and subsystems. 2024-08-15 11:45:18 -06:00
tsconfig.json feat(keymap-upgrader): Upgrade renamed nodes 2024-01-25 18:03:37 -06: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.