History

dependabot[bot] 18c988d7e9 chore(deps): bump @docusaurus/preset-classic in /docs Bumps [@docusaurus/preset-classic](https://github.com/facebook/docusaurus/tree/HEAD/packages/docusaurus-preset-classic) from 2.0.0-beta.0 to 2.0.0-beta.1. - [Release notes](https://github.com/facebook/docusaurus/releases) - [Changelog](https://github.com/facebook/docusaurus/blob/master/CHANGELOG.md) - [Commits](https://github.com/facebook/docusaurus/commits/v2.0.0-beta.1/packages/docusaurus-preset-classic) --- updated-dependencies: - dependency-name: "@docusaurus/preset-classic" dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com>		2021-06-21 20:04:07 +01:00
..
blog	refactor: Move to new zmk.dev domain name.	2021-06-10 09:27:57 -04:00
docs	docs(setup): fix whitespace in Fedora toolchain install command	2021-06-16 16:23:53 -05:00
src	chore(docs): Bump prettier, and reformat w/ it.	2021-06-09 10:58:53 -04:00
static	fix(setup): Fix index to MakerDiary m.2 board	2021-02-03 23:10:47 -05: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	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	refactor: Move to new zmk.dev domain name.	2021-06-10 09:27:57 -04:00
netlify.toml	fix(docs): Add permanent redict to zmk.dev domain.	2021-06-10 10:06:41 -04:00
package-lock.json	chore(deps): bump @docusaurus/preset-classic in /docs	2021-06-21 20:04:07 +01:00
package.json	chore(deps): bump @docusaurus/preset-classic in /docs	2021-06-21 20:04:07 +01:00
README.md	fix(docs): Explicit CC-BY-NC-SA license for docs.	2020-10-26 23:15:48 -04:00
sidebars.js	Docs: added mod morph page (#749 )	2021-04-05 18:04:38 -05: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.