zmk/docs
Nicolas Munnich 5487b108d5
docs: fixing some more broken anchors (#2586)
2024-10-23 02:16:59 +02:00
..
blog blog: Remove reference to spaceman (#2520) 2024-09-30 19:43:58 -07:00
docs docs: fixing some more broken anchors (#2586) 2024-10-23 02:16:59 +02:00
src docs(codes): Android Support: Basic Controls and Input + Display (#603) 2024-10-20 23:57:00 +02:00
static docs: Physical layout docs improvements (#2533) 2024-10-12 21:25:45 +02:00
.eslintignore
.eslintrc.js
.gitignore
.nvmrc
.prettierignore feat: Generate setup scripts from metadata. 2021-09-11 00:50:36 -04:00
.prettierrc.js
README.md
docusaurus.config.js docs: Added mastodon link in footer 2024-10-17 15:01:30 -06:00
netlify.toml
package-lock.json chore(deps): bump http-proxy-middleware from 2.0.6 to 2.0.7 in /docs (#2585) 2024-10-23 01:52:19 +02:00
package.json chore(deps): bump @mdx-js/react from 3.0.1 to 3.1.0 in /docs (#2580) 2024-10-23 01:48:09 +02:00
sidebars.js docs: Physical layout docs improvements (#2533) 2024-10-12 21:25:45 +02: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.