zmk/docs/README.md
Joel Spadin 65667b863a docs: Add syntax highlighting to more code blocks
Added language tags to more code blocks in the documentation to enable
syntax highlighting.
2023-10-09 15:19:24 -07:00

30 lines
623 B
Markdown

# Website
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
## License
The ZMK Documentation is licensed [CC-BY-NC-SA](http://creativecommons.org/licenses/by-nc-sa/4.0/).
### Installation
```sh
$ npm ci
```
### Local Development
```sh
$ 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
```sh
$ npm build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.