zmk/docs
Anant Thazhemadam 6946ca8b07
fix(docs): minor corrections and fix typo (#2443)
* docs(faq): minor corrections

* docs: fix typo - `s/Alterative/Alternative`

* docs(faq): use Lily58 as an example instead of Corne with revision

Co-authored-by: Nicolas Munnich <98408764+Nick-Munnich@users.noreply.github.com>

---------

Co-authored-by: Nicolas Munnich <98408764+Nick-Munnich@users.noreply.github.com>
2024-08-27 16:23:15 +02:00
..
blog refactor(docs): Convert the keymaps section into a base folder (#2430) 2024-08-21 10:39:18 -07:00
docs fix(docs): minor corrections and fix typo (#2443) 2024-08-27 16:23:15 +02:00
src refactor(docs): Convert the keymaps section into a base folder (#2430) 2024-08-21 10:39:18 -07:00
static refactor(docs): Convert the keymaps section into a base folder (#2430) 2024-08-21 10:39:18 -07:00
.eslintignore
.eslintrc.js ci(docs): Disable eslint rule for unescaped entities 2024-01-20 22:28:41 -08:00
.gitignore
.nvmrc
.prettierignore
.prettierrc.js
README.md
docusaurus.config.js feat(studio): Initial RPC infrastructure and subsystems. 2024-08-15 11:45:18 -06:00
netlify.toml
package-lock.json feat(studio): Initial RPC infrastructure and subsystems. 2024-08-15 11:45:18 -06:00
package.json feat(studio): Initial RPC infrastructure and subsystems. 2024-08-15 11:45:18 -06:00
sidebars.js refactor(docs): Convert the keymaps section into a base folder (#2430) 2024-08-21 10:39:18 -07: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.