History

dependabot[bot] bac6bda34c chore(deps): bump the docusaurus-minor-patch group (#2631 ) Bumps the docusaurus-minor-patch group in /docs with 3 updates: [@docusaurus/core](https://github.com/facebook/docusaurus/tree/HEAD/packages/docusaurus), [@docusaurus/preset-classic](https://github.com/facebook/docusaurus/tree/HEAD/packages/docusaurus-preset-classic) and [@docusaurus/theme-mermaid](https://github.com/facebook/docusaurus/tree/HEAD/packages/docusaurus-theme-mermaid). Updates `@docusaurus/core` from 3.5.2 to 3.6.1 - [Release notes](https://github.com/facebook/docusaurus/releases) - [Changelog](https://github.com/facebook/docusaurus/blob/main/CHANGELOG.md) - [Commits](https://github.com/facebook/docusaurus/commits/v3.6.1/packages/docusaurus) Updates `@docusaurus/preset-classic` from 3.5.2 to 3.6.1 - [Release notes](https://github.com/facebook/docusaurus/releases) - [Changelog](https://github.com/facebook/docusaurus/blob/main/CHANGELOG.md) - [Commits](https://github.com/facebook/docusaurus/commits/v3.6.1/packages/docusaurus-preset-classic) Updates `@docusaurus/theme-mermaid` from 3.5.2 to 3.6.1 - [Release notes](https://github.com/facebook/docusaurus/releases) - [Changelog](https://github.com/facebook/docusaurus/blob/main/CHANGELOG.md) - [Commits](https://github.com/facebook/docusaurus/commits/v3.6.1/packages/docusaurus-theme-mermaid) --- updated-dependencies: - dependency-name: "@docusaurus/core" dependency-type: direct:production update-type: version-update:semver-minor dependency-group: docusaurus-minor-patch - dependency-name: "@docusaurus/preset-classic" dependency-type: direct:production update-type: version-update:semver-minor dependency-group: docusaurus-minor-patch - dependency-name: "@docusaurus/theme-mermaid" dependency-type: direct:production update-type: version-update:semver-minor dependency-group: docusaurus-minor-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>		2024-11-11 01:05:54 +01:00
..
blog	blog: Remove reference to spaceman (#2520 )	2024-09-30 19:43:58 -07:00
docs	docs: Fix typos in local-toolchain/setup (#2626 )	2024-11-10 01:09:29 +01: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	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
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	fix(docs): Allow CORS for hardware-metadata.json	2022-03-30 07:13:13 -04:00
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	feat(docs) Adding some additional clarity around low power states (#2330 )	2024-11-02 23:20:31 +01: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.