zmkfirmware
/
zmk
mirror of https://github.com/zmkfirmware/zmk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
zmk/docs
History
Cem Aksoylar 61325ee82c
docs: Document requirements-extra.txt and endpoint selection for Studio (#3001) 
* docs: Document requirements-extra.txt for Studio builds

* docs: Note endpoint selection requirement for Studio

* docs: Fix indents in list items in native setup page

Add this file to .prettierignore because it messes all the additional indents.
There is also no way to make prettier ignore a range of lines in MDX files AFAICT.

* Revert "docs: Fix indents in list items in native setup page"

This reverts commit 6d8aeba801.
 		2025-07-21 17:11:06 +02:00
..
blog blog: Add blog post on pinning ZMK version (#2974) 2025-07-03 17:27:11 +02:00
docs docs: Document requirements-extra.txt and endpoint selection for Studio (#3001) 2025-07-21 17:11:06 +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
…
.nvmrc
…
.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
README.md
…
docusaurus.config.js
…
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 the docusaurus-minor-patch group (#2948) 2025-06-01 23:21:14 -07:00
package.json chore(deps): bump the docusaurus-minor-patch group (#2948) 2025-06-01 23:21:14 -07:00
sidebars.js docs: Update hold-tap page (#2888) 2025-03-23 18:12:50 -07: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.