mirror of https://github.com/zmkfirmware/zmk.git synced 2026-03-20 04:55:20 -05:00

Files

Cem Aksoylar 5cbffd6625 fix(docs): Work around docusaurus bug causing broken links

Some links ended up broken after docusaurus 3 upgrade,
especially if they are the second on the same line and have anchors.
Likely due to https://github.com/facebook/docusaurus/issues/9518

2024-01-20 22:28:41 -08:00

blog

refactor(docs): Use .mdx for docs with mdx features

2024-01-20 22:28:41 -08:00

docs

fix(docs): Work around docusaurus bug causing broken links

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

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

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(docs): Update docusaurus to 3

2024-01-20 22:28:41 -08:00

package.json

chore(docs): Update docusaurus to 3

2024-01-20 22:28:41 -08: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

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.