zmkfirmware
/
zmk
mirror of https://github.com/zmkfirmware/zmk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
zmk/docs
History
Pete Johanson 6934e362b5
docs(ci): Netlify ignore command to check branch (#2659) 
Add a separate ignore script that checks git changes but also
only deploys main and version branches to allow us to deploy
versioned docs.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 		2024-11-18 20:26:26 -05:00
..
blog blog: Add ZMK Studio release blog post. 2024-11-11 16:44:06 -07:00
docs feat(ci): Add release-please automation with VERSION (#2622) 2024-11-18 16:46:26 -05: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 ci(docs): Disable eslint rule for unescaped entities 2024-01-20 22:28:41 -08:00
.gitignore
…
.nvmrc
…
.prettierignore
…
.prettierrc.js
…
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-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 cross-spawn from 7.0.3 to 7.0.6 in /docs 2024-11-18 14:22:33 -08:00
package.json chore(deps): bump the docusaurus-minor-patch group (#2631) 2024-11-11 01:05:54 +01:00
sidebars.js feat(ci): Add release-please automation with VERSION (#2622) 2024-11-18 16:46:26 -05: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.