tgrosinger/zmk
1
0
Fork 0
Code Actions Packages
83a151890c
zmk/docs
History
sporkus 83a151890c
fix(docs): Correct example keymap filename
2023-04-16 13:28:08 -07:00
..
blog
fix(docs): Make link to keymap upgrader work.
2023-04-05 23:18:34 -07:00
docs
fix(docs): Correct example keymap filename
2023-04-16 13:28:08 -07:00
src
refactor(behaviors): Rename reset behavior.
2023-04-05 22:55:38 -07: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): Standardize URLs with no trailing slash
2022-05-23 10:09:53 -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): bump http-cache-semantics from 4.1.0 to 4.1.1 in /docs
2023-02-25 01:27:37 -05:00
package.json
fix(docs): npm start to work from Docker.
2022-10-26 23:02:54 -05: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 BLE feature/config pages.
2023-04-05 22:55:38 -07: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.