History

Aaron Nunley 100d06ae8b Update docs for testing a new shield. Clarifying the need for `west flash` in a dockerized environment and providing a high-level overview of testing a board with UF2 support.		2021-02-02 01:02:54 -05:00
..
blog	fix(blog): Updated link to combos docs.	2021-01-27 22:49:57 -05:00
docs	Update docs for testing a new shield.	2021-02-02 01:02:54 -05:00
src	fix(docs): Set description to our tagline	2021-01-29 23:58:42 -05:00
static	fix(setup.sh): rename BF0-9000 to BFO-9000	2021-01-13 21:00:38 -05:00
.eslintignore	docs: Add eslint support	2020-10-25 21:23:16 +00:00
.eslintrc.js	docs: Add eslint-mdx support	2020-10-25 21:25:01 +00: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	docs: Add prettier support	2020-10-25 21:24:55 +00:00
.prettierrc.js	docs: Set prettier endOfLine to auto	2020-10-26 05:28:31 +00:00
docusaurus.config.js	docs: remove redundant slash from "docs/" navigation item	2021-01-30 00:02:11 -05:00
netlify.toml	Move the netlify.toml file into docs/	2020-07-03 10:43:27 -04:00
package-lock.json	feat(docs): add keymap upgrader	2020-12-10 12:23:05 +00:00
package.json	feat(docs): add keymap upgrader	2020-12-10 12:23:05 +00: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 information on how to update the documentation to the docs	2021-01-29 20:44:39 -06:00

Website

This website is built using Docusaurus 2, a modern static website generator.

License

The ZMK Documentation is licensed CC-BY-NC-SA.

$ npm ci

$ 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.

$ npm build

This command generates static content into the build directory and can be served using any static contents hosting service.