zmk_mf68/docs/README.md

30 lines
617 B
Markdown
Raw Normal View History

2020-05-26 11:33:21 +10:00
# 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/).
2020-05-26 11:33:21 +10:00
### 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.