kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
zmk/docs
History
Joel Spadin 37fcf190e6 feat(keymap-upgrader): Highlight changes 
Updated the keymap upgrader to highlight which lines it changed as well
as indicate when nothing needed to be upgraded.

Also adjusted the line highlight colors to be more readable in both
light and dark color schemes.
2024-01-25 18:03:37 -06:00
..
blog fix(docs): Fix links to keymap upgrader 2024-01-25 18:03:37 -06:00
docs refactor: Improve keymap upgrader 2024-01-25 18:03:37 -06:00
src feat(keymap-upgrader): Highlight changes 2024-01-25 18:03:37 -06:00
static docs: Update tree-sitter 2023-05-20 01:33:11 -06: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 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
docusaurus.config.js refactor: Improve keymap upgrader 2024-01-25 18:03:37 -06:00
netlify.toml fix(docs): Allow CORS for hardware-metadata.json 2022-03-30 07:13:13 -04:00
package-lock.json chore(docs): Update docusaurus to 3 2024-01-20 22:28:41 -08:00
package.json chore(docs): Update docusaurus to 3 2024-01-20 22:28:41 -08:00
README.md docs: Add syntax highlighting to more code blocks 2023-10-09 15:19:24 -07:00
sidebars.js refactor: Improve keymap upgrader 2024-01-25 18:03:37 -06:00
tsconfig.json refactor: Improve keymap upgrader 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.