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

Files

Peter Johanson 60d367cbb9 refactor(docs): Bump to docusaurus 2.0.0-beta.18

* Fix up the config to use proper locations.

2022-04-06 06:01:39 -04:00

blog

fix(blog): Whitespace issue w/ blog addition.

2022-04-03 05:31:05 +00:00

docs

fix(docs): Improve powershell command for setup script for failure cases

2022-04-03 08:39:15 +01:00

src

fix(docs): Clear up ambiguity on supported hardware page (#1200 )

2022-03-30 08:51:12 +01: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

refactor(docs): Bump to docusaurus 2.0.0-beta.18

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

refactor(docs): Bump to docusaurus 2.0.0-beta.18

2022-04-06 06:01:39 -04:00

package.json

refactor(docs): Bump to docusaurus 2.0.0-beta.18

2022-04-06 06:01:39 -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): Document the macro behavior.

2022-03-23 23:42:54 -04:00

tsconfig.json

feat(docs): Type check the docs TSX components.

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