aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/README.md
blob: 1fd6775d534ce1deecdc45a07bbe0ecffba15831 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# 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.