History

Nicolas Munnich 7d8dd64cdc docs: Added a page on pin control for ZMK (#2508 ) * docs(feat): Added a page on pin control for ZMK * Added note on HAL modules * docs: Added images of boards --------- Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>		2024-10-27 02:31:47 +02:00
..
blog	blog: Remove reference to spaceman (#2520 )	2024-09-30 19:43:58 -07:00
docs	docs: Added a page on pin control for ZMK (#2508 )	2024-10-27 02:31:47 +02:00
src	docs: Added a page on pin control for ZMK (#2508 )	2024-10-27 02:31:47 +02:00
static	Update web-tree-sitter and tweak keymap upgrader (#2593 )	2024-10-26 09:55:09 +02:00
.eslintignore	docs: Add eslint support	2020-10-25 21:23:16 +00:00
.eslintrc.js	ci(docs): Disable eslint rule for unescaped entities	2024-01-20 22:28:41 -08:00
.gitignore	…
.nvmrc	docs: Set netlify node version to lts/*	2020-10-26 22:55:15 +00:00
.prettierignore	feat: Generate setup scripts from metadata.	2021-09-11 00:50:36 -04:00
.prettierrc.js	docs: Set prettier endOfLine to auto	2020-10-26 05:28:31 +00:00
README.md	docs: Add syntax highlighting to more code blocks	2023-10-09 15:19:24 -07:00
docusaurus.config.js	docs: Added mastodon link in footer	2024-10-17 15:01:30 -06:00
netlify.toml	fix(docs): Allow CORS for hardware-metadata.json	2022-03-30 07:13:13 -04:00
package-lock.json	Update web-tree-sitter and tweak keymap upgrader (#2593 )	2024-10-26 09:55:09 +02:00
package.json	Update web-tree-sitter and tweak keymap upgrader (#2593 )	2024-10-26 09:55:09 +02:00
sidebars.js	docs: Added a page on pin control for ZMK (#2508 )	2024-10-27 02:31:47 +02:00
tsconfig.json	Update web-tree-sitter and tweak keymap upgrader (#2593 )	2024-10-26 09:55:09 +02: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.