mirror of https://github.com/zmkfirmware/zmk.git synced 2026-03-20 04:55:20 -05:00

Files

Adrien LUDWIG 8d06a9b713 docs: fix missing link and example introduction (#3064 )

* docs: fix example introduction

* docs: fix missing link

2025-09-08 18:15:41 +02:00

blog

docs: Add warning box for clearing settings for splits, generalize troubleshooting procedure (#3039 )

2025-08-19 17:27:21 -07:00

docs

docs: fix missing link and example introduction (#3064 )

2025-09-08 18:15:41 +02:00

src

chore(docs): Fix prettier warnings (#2952 )

2025-06-01 12:02:39 -07:00

static

docs: Update hold-tap page (#2888 )

2025-03-23 18:12:50 -07:00

.gitignore

Initial work on basic documentation.

2020-05-25 21:33:21 -04:00

.nvmrc

docs: Set netlify node version to lts/*

2020-10-26 22:55:15 +00:00

.prettierignore

chore: Add typescript support to eslint, fix errors (#2923 )

2025-04-22 20:51:41 -07:00

.prettierrc.js

chore: Add typescript support to eslint, fix errors (#2923 )

2025-04-22 20:51:41 -07:00

docusaurus.config.js

docs: Added mastodon link in footer

2024-10-17 15:01:30 -06:00

eslint.config.mjs

chore: Add typescript support to eslint, fix errors (#2923 )

2025-04-22 20:51:41 -07: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 http-proxy-middleware from 2.0.7 to 2.0.9 in /docs (#2929 )

2025-08-04 22:54:01 +01:00

package.json

chore(deps): bump the docusaurus-minor-patch group across 1 directory with 3 updates (#2973 )

2025-08-04 22:29:08 +01:00

README.md

docs: Add syntax highlighting to more code blocks

2023-10-09 15:19:24 -07:00

sidebars.js

docs: Add a dedicated page on ZMK events (#2815 )

2025-08-18 23:45:16 +02:00

tsconfig.json

chore: Add typescript support to eslint, fix errors (#2923 )

2025-04-22 20:51:41 -07: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.