zmk/docs
dependabot[bot] f8654dafd5
chore(deps-dev): bump prettier from 2.8.7 to 3.2.4 in /docs
Bumps [prettier](https://github.com/prettier/prettier) from 2.8.7 to 3.2.4.
- [Release notes](https://github.com/prettier/prettier/releases)
- [Changelog](https://github.com/prettier/prettier/blob/main/CHANGELOG.md)
- [Commits](https://github.com/prettier/prettier/compare/2.8.7...3.2.4)

---
updated-dependencies:
- dependency-name: prettier
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-01-21 06:29:38 +00:00
..
blog refactor(docs): Use .mdx for docs with mdx features 2024-01-20 22:28:41 -08:00
docs fix(docs): Fix extra line issue in hardware headers 2024-01-20 22:28:41 -08:00
src refactor(docs): Remove no longer necessary React imports 2024-01-20 22:28:41 -08: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 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
docusaurus.config.js refactor(docs): Use new admonition title syntax and disable mdx v1 compat 2024-01-20 22:28:41 -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-dev): bump prettier from 2.8.7 to 3.2.4 in /docs 2024-01-21 06:29:38 +00:00
package.json chore(deps-dev): bump prettier from 2.8.7 to 3.2.4 in /docs 2024-01-21 06:29:38 +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 ci(docs): Fix tsc config for docusaurus 3 2024-01-20 22:28:41 -08: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.