summaryrefslogtreecommitdiff
path: root/site/README.md
blob: 4688be7f38afab1bbad524a0dddb2b2c3a26b165 (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
30
# OpenDC docs site

This directory contains the sources for the [OpenDC website](https://opendc.org). The website is built 
using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.

### Installation

```
$ npm i
```

### Local Development

```
$ npm run start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```
$ npm run build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

The site is automatically deployed using GitHub Actions.