zmk/docs
dependabot[bot] a9b1b33427
chore(deps): bump the npm_and_yarn group group in /docs with 2 updates
Bumps the npm_and_yarn group group in /docs with 2 updates: [@docusaurus/core](https://github.com/facebook/docusaurus/tree/HEAD/packages/docusaurus) and [@docusaurus/preset-classic](https://github.com/facebook/docusaurus/tree/HEAD/packages/docusaurus-preset-classic).


Updates `@docusaurus/core` from 2.4.0 to 3.1.0
- [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.1.0/packages/docusaurus)

Updates `@docusaurus/preset-classic` from 2.4.0 to 3.1.0
- [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.1.0/packages/docusaurus-preset-classic)

---
updated-dependencies:
- dependency-name: "@docusaurus/core"
  dependency-type: direct:production
  dependency-group: npm_and_yarn-security-group
- dependency-name: "@docusaurus/preset-classic"
  dependency-type: direct:production
  dependency-group: npm_and_yarn-security-group
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-01-12 18:45:13 +00:00
..
blog feat(blog): Add post for joelspadin projects for spotlight series (#2092) 2024-01-05 10:42:04 -08:00
docs fixup! docs 2024-01-05 12:16:38 -08:00
src feat(docs): Document globe key specific quirks 2023-10-10 14:04:28 -07:00
static docs: Update tree-sitter 2023-05-20 01:33:11 -06:00
.eslintignore docs: Add eslint support 2020-10-25 21:23:16 +00:00
.eslintrc.js fix(docs): Updated eslint config for unified prettier setup. 2021-05-05 00:54:55 -04: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
docusaurus.config.js feat(blog): Show all posts on sidebar 2023-11-08 23:00:26 -08: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 npm_and_yarn group group in /docs with 2 updates 2024-01-12 18:45:13 +00:00
package.json chore(deps): bump the npm_and_yarn group group in /docs with 2 updates 2024-01-12 18:45:13 +00:00
README.md docs: Add syntax highlighting to more code blocks 2023-10-09 15:19:24 -07:00
sidebars.js feat(mouse): Initial mouse keys support. 2023-11-15 11:16:59 -08:00
tsconfig.json fix(docs): Fix typescript error 2023-05-20 01:33:11 -06:00

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.