zephyr
/
zmk
mirror of https://github.com/zmkfirmware/zmk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
zmk/docs
History
Tygo van den Hurk 84772ebf14
fix: changed shebang to make scripts more platform independent (#2893) 
See for example this thread:

https://stackoverflow.com/questions/21612980/why-is-usr-bin-env-bash-superior-to-bin-bash

on why its better to use '#!/usr/bin/env bash' instead.
Without this change these scripts will not run on some
platforms. This is not a breaking change for the
platforms it already works on.
 		2025-04-20 04:23:31 -04:00
..
blog blog: Add meeting notes from February (#2890) 2025-03-25 19:20:50 +01:00
docs docs: fix path typo in module-creation.md (#2920) 2025-04-16 09:53:56 -07:00
src fix: changed shebang to make scripts more platform independent (#2893) 2025-04-20 04:23:31 -04: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 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
eslint.config.mjs chore(eslint): upgrade to eslint v9 and flat config (#2909) 2025-04-06 18:16:03 -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 estree-util-value-to-estree in /docs (#2914) 2025-04-07 21:54:32 -07:00
package.json chore(eslint): upgrade to eslint v9 and flat config (#2909) 2025-04-06 18:16:03 -07:00
sidebars.js docs: Update hold-tap page (#2888) 2025-03-23 18:12:50 -07: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.