Jacob/zmk

Files

Ivan Smirnov bb32005474 fix(docs): Update macos GCC embedded section with brew cmd

* Update macos GCC embedded section with brew cmd

Brew has a cask for GCC embedded, so we can make this guide more user friendly by providing it.

2021-06-08 20:56:10 -04:00

blog

fix(blog): Updated link to combos docs.

2021-01-27 22:49:57 -05:00

docs

fix(docs): Update macos GCC embedded section with brew cmd

2021-06-08 20:56:10 -04:00

src

fix(docs): Readjusted colors for dark theme for OSes in docs

2021-05-05 00:21:27 -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

feat(docs): Added support for prefers-color-scheme in docs

2021-05-05 00:15:38 -04:00

netlify.toml

Move the netlify.toml file into docs/

2020-07-03 10:43:27 -04:00

package-lock.json

chore(deps-dev): bump eslint-plugin-mdx from 1.8.2 to 1.13.0 in /docs

2021-05-17 09:29:46 -04:00

package.json

chore(deps-dev): bump eslint-plugin-mdx from 1.8.2 to 1.13.0 in /docs

2021-05-17 09:29:46 -04: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.