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