xenua
/
zmk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1340 Commits
1 Branch
0 Tags
14 MiB
 
 
 
 
 
Tree: 100d06ae8b
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '100d06ae8b'
${ noResults }
zmk/docs
Aaron Nunley 100d06ae8b
Update docs for testing a new shield. 		4 years ago
..
blog fix(blog): Updated link to combos docs. 4 years ago
docs Update docs for testing a new shield. 4 years ago
src fix(docs): Set description to our tagline 4 years ago
static fix(setup.sh): rename BF0-9000 to BFO-9000 4 years ago
.eslintignore docs: Add eslint support 4 years ago
.eslintrc.js docs: Add eslint-mdx support 4 years ago
.gitignore Initial work on basic documentation. 5 years ago
.nvmrc docs: Set netlify node version to lts/* 4 years ago
.prettierignore docs: Add prettier support 4 years ago
.prettierrc.js docs: Set prettier endOfLine to auto 4 years ago
README.md fix(docs): Explicit CC-BY-NC-SA license for docs. 4 years ago
docusaurus.config.js docs: remove redundant slash from "docs/" navigation item 4 years ago
netlify.toml Move the netlify.toml file into docs/ 4 years ago
package-lock.json feat(docs): add keymap upgrader 4 years ago
package.json feat(docs): add keymap upgrader 4 years ago
sidebars.js feat(docs): add information on how to update the documentation to the docs 4 years ago

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.