kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
zmk/docs
History
Nicolas Munnich dd8f66470e Merge branch 'shift-registers' of github.com:Nick-Munnich/zmk into shift-registers
2024-09-02 12:50:46 +02:00
..
blog refactor(docs): Refactor the development section (#2438) 2024-09-01 21:54:19 -07:00
docs Merge branch 'shift-registers' of github.com:Nick-Munnich/zmk into shift-registers 2024-09-02 12:50:46 +02:00
src Removed popup, added warnings instead 2024-08-30 20:28:27 +02:00
static refactor(docs): Refactor the development section (#2438) 2024-09-01 21:54:19 -07:00
.eslintignore docs: Add eslint support 2020-10-25 21:23:16 +00:00
.eslintrc.js ci(docs): Disable eslint rule for unescaped entities 2024-01-20 22:28:41 -08: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 feat: Generate setup scripts from metadata. 2021-09-11 00:50:36 -04:00
.prettierrc.js docs: Set prettier endOfLine to auto 2020-10-26 05:28:31 +00:00
docusaurus.config.js refactor(docs): Refactor the development section (#2438) 2024-09-01 21:54:19 -07:00
netlify.toml fix(docs): Allow CORS for hardware-metadata.json 2022-03-30 07:13:13 -04:00
package-lock.json chore(deps): bump web-tree-sitter from 0.20.8 to 0.23.0 in /docs 2024-09-01 22:57:37 -07:00
package.json chore(deps): bump web-tree-sitter from 0.20.8 to 0.23.0 in /docs 2024-09-01 22:57:37 -07:00
README.md docs: Add syntax highlighting to more code blocks 2023-10-09 15:19:24 -07:00
sidebars.js Added a page on shift registers 2024-09-02 10:22:23 +02:00
tsconfig.json feat(keymap-upgrader): Upgrade renamed nodes 2024-01-25 18:03:37 -06: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.