kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
zmk/docs
History
Joel Spadin 76c437647e Improve user setup process 
Changed the user setup documentation to use a new setup process where
users create the repo from the template repo, then run one of two new
tools to add a keyboard to it:

- In a web browser, using github.dev and the ZMK Tools extension.
- Locally, using a new Python setup script.

Also made various other improvements to the setup documentation, such
as including instructions for flashing keyboards that use DFU instead of
UF2.
2022-08-28 12:21:43 -05:00
..
blog feat(blog): Add second birthday post. 2022-04-21 04:05:25 +00:00
docs Improve user setup process 2022-08-28 12:21:43 -05:00
src feat(hid): Add C_AC_DESKTOP_SHOW_ALL_APPLICATIONS 2022-08-22 00:27:47 -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): 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 fix(docs): Fix acorn dep in package lock file. 2022-06-06 11:05:47 -04:00
package.json chore: Bump docusaurus and fix deps issue. 2022-06-03 00:35:07 -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): Update power and lighting config pages 2022-07-03 18:55:54 +01: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.