zmk/docs
Peter Johanson 14c6fb74ee ci: Add gitlint and document commit conventions
* Add gitlint to pre-commit setup
* Update pre-commit setup for installing commit-hooks
* Add "Commit Conventions" contributing docs

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2024-11-12 18:39:27 -07:00
..
blog blog: Add ZMK Studio release blog post. 2024-11-11 16:44:06 -07:00
docs ci: Add gitlint and document commit conventions 2024-11-12 18:39:27 -07:00
src chore: Marking C_AL_CALENDAR / C_AL_CAL as not available on macOS and iOS. (#2606) 2024-11-03 08:31:27 +01:00
static Update web-tree-sitter and tweak keymap upgrader (#2593) 2024-10-26 09:55:09 +02:00
.eslintignore
.eslintrc.js
.gitignore
.nvmrc
.prettierignore
.prettierrc.js
README.md
docusaurus.config.js docs: Added mastodon link in footer 2024-10-17 15:01:30 -06:00
netlify.toml
package-lock.json chore(deps): bump the docusaurus-minor-patch group (#2631) 2024-11-11 01:05:54 +01:00
package.json chore(deps): bump the docusaurus-minor-patch group (#2631) 2024-11-11 01:05:54 +01:00
sidebars.js ci: Add gitlint and document commit conventions 2024-11-12 18:39:27 -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.