zmk/docs
Cem Aksoylar 0827ff245f chore(docs): Update docusaurus to 3
Following https://docusaurus.io/docs/migration/v3#upgrading-dependencies
and `npm update`
2024-01-20 22:28:41 -08:00
..
blog feat(blog): Add post for joelspadin projects for spotlight series (#2092) 2024-01-05 10:42:04 -08:00
docs fix(docs): Document `CONFIG_ZMK_USB_BOOT` 2024-01-12 11:02:47 -08:00
src docs: confirm some consumer codes on iOS 2024-01-15 18:07:48 -08:00
static docs: Update tree-sitter 2023-05-20 01:33:11 -06:00
.eslintignore
.eslintrc.js
.gitignore
.nvmrc
.prettierignore
.prettierrc.js
README.md docs: Add syntax highlighting to more code blocks 2023-10-09 15:19:24 -07:00
docusaurus.config.js feat(blog): Show all posts on sidebar 2023-11-08 23:00:26 -08:00
netlify.toml
package-lock.json chore(docs): Update docusaurus to 3 2024-01-20 22:28:41 -08:00
package.json chore(docs): Update docusaurus to 3 2024-01-20 22:28:41 -08:00
sidebars.js feat(mouse): Initial mouse keys support. 2023-11-15 11:16:59 -08:00
tsconfig.json fix(docs): Fix typescript error 2023-05-20 01:33:11 -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.