diff options
Diffstat (limited to 'site/README.md')
| -rw-r--r-- | site/README.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/site/README.md b/site/README.md new file mode 100644 index 00000000..4688be7f --- /dev/null +++ b/site/README.md @@ -0,0 +1,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. |