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.
1737 Commits
1 Branch
0 Tags
14 MiB
 
 
 
 
 
Tree: 0e54603ec6
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '0e54603ec6'
${ noResults }
zmk/docs
DoctorNefario 0e54603ec6
fix(docs): Clarify backlight & underglow use cases 		3 years ago
..
blog feat(blog): Add SOTF #5. 3 years ago
docs fix(docs): Clarify backlight & underglow use cases 3 years ago
src fix(docs): Clear up ambiguity on supported hardware page (#1200) 3 years ago
static feat: Generate setup scripts from metadata. 3 years ago
.eslintignore docs: Add eslint support 4 years ago
.eslintrc.js fix(docs): Updated eslint config for unified prettier setup. 4 years ago
.gitignore Initial work on basic documentation. 5 years ago
.nvmrc docs: Set netlify node version to lts/* 4 years ago
.prettierignore feat: Generate setup scripts from metadata. 3 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 fix(docs): Remove breadcrumbs (for now) 3 years ago
netlify.toml fix(docs): Allow CORS for hardware-metadata.json 3 years ago
package-lock.json chore(deps): bump browserslist from 4.14.5 to 4.20.2 in /docs 3 years ago
package.json refactor(docs): Bump typescript dependency. 3 years ago
sidebars.js feat(docs): Document the macro behavior. 3 years ago
tsconfig.json feat(docs): Type check the docs TSX components. 3 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.