mirror of https://github.com/zmkfirmware/zmk.git synced 2026-03-19 20:45:18 -05:00

Files

Kurtis Lew 8bbbf530a7 fix(docs): Remove code-snippet backticks from customization.md title

Discussed here: https://discord.com/channels/719497620560543766/883452966114324550/970385441134104747

Code snippets in titles are not formatted properly in page titles

2022-05-01 21:14:19 +01:00

blog

feat(blog): Add second birthday post.

2022-04-21 04:05:25 +00:00

docs

fix(docs): Remove code-snippet backticks from customization.md title

2022-05-01 21:14:19 +01:00

src

feat(docs): Add TOC to supported hardware page.

2022-04-19 07:05:26 -04:00

static

feat: Generate setup scripts from metadata.

2021-09-11 00:50:36 -04: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

fix(docs): Remove breadcrumbs (for now)

2022-04-06 06:01:39 -04: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 eslint-plugin-mdx from 1.13.0 to 1.17.0 in /docs

2022-04-19 00:56:13 -04:00

package.json

chore(deps-dev): bump eslint-plugin-mdx from 1.13.0 to 1.17.0 in /docs

2022-04-19 00:56:13 -04:00

README.md

fix(docs): Explicit CC-BY-NC-SA license for docs.

2020-10-26 23:15:48 -04:00

sidebars.js

feat(docs): Add battery sensor documentation

2022-04-17 11:30:57 -04:00

tsconfig.json

feat(docs): Add TOC to supported hardware page.

2022-04-19 07:05:26 -04: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.