zmk/docs
idesignstuff 5d9920406c
Update container.mdx for clarity about ZMK repo folder location (#2868)
2025-03-10 21:52:30 -07:00
..
blog
docs Update container.mdx for clarity about ZMK repo folder location (#2868) 2025-03-10 21:52:30 -07:00
src docs: Add query strings to tabs (#2840) 2025-02-25 16:31:57 -08:00
static
.eslintignore
.eslintrc.js
.gitignore
.nvmrc
.prettierignore
.prettierrc.js
README.md
docusaurus.config.js
netlify-ignore-command.sh
netlify.toml
package-lock.json chore(deps): bump katex from 0.16.11 to 0.16.21 in /docs (#2774) 2025-01-17 15:15:54 -08:00
package.json
sidebars.js docs: Add a page on module creation (#2456) 2025-02-14 16:32:18 -08:00
tsconfig.json

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.