mirror of https://github.com/zmkfirmware/zmk.git synced 2026-03-20 04:55:20 -05:00

Files

Megamannen a7c6e080a7 Fix broken link in documentation (encoders) (#707 )

* Update encoders.md

Link to "New Keyboard Shield" didn't work

* Update encoders.md

Forgot hash-link

2021-03-03 00:06:29 -06:00

blog

fix(blog): Updated link to combos docs.

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

docs

Fix broken link in documentation (encoders) (#707 )

2021-03-03 00:06:29 -06:00

src

fix(docs): Set description to our tagline

2021-01-29 23:58:42 -05: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

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

docs: Add docs for setting up vscode

2021-02-09 00:45:55 -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.