History

dependabot[bot] e9681270d3 chore(deps): bump @mdx-js/react from 3.0.1 to 3.1.0 in /docs (#2580 ) Bumps [@mdx-js/react](https://github.com/mdx-js/mdx/tree/HEAD/packages/react) from 3.0.1 to 3.1.0. - [Release notes](https://github.com/mdx-js/mdx/releases) - [Changelog](https://github.com/mdx-js/mdx/blob/main/changelog.md) - [Commits](https://github.com/mdx-js/mdx/commits/3.1.0/packages/react) --- updated-dependencies: - dependency-name: "@mdx-js/react" dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>		2024-10-23 01:48:09 +02:00
..
blog	blog: Remove reference to spaceman (#2520 )	2024-09-30 19:43:58 -07:00
docs	feat: Add `studio` as a feature option in metadata	2024-10-17 10:20:30 -06:00
src	docs(codes): Android Support: Basic Controls and Input + Display (#603 )	2024-10-20 23:57:00 +02:00
static	docs: Physical layout docs improvements (#2533 )	2024-10-12 21:25:45 +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.toml	…
package-lock.json	chore(deps): bump @mdx-js/react from 3.0.1 to 3.1.0 in /docs (#2580 )	2024-10-23 01:48:09 +02:00
package.json	chore(deps): bump @mdx-js/react from 3.0.1 to 3.1.0 in /docs (#2580 )	2024-10-23 01:48:09 +02:00
sidebars.js	docs: Physical layout docs improvements (#2533 )	2024-10-12 21:25:45 +02:00
tsconfig.json	feat(keymap-upgrader): Upgrade renamed nodes	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.