diff options
| author | Fabian Mastenbroek <mail.fabianm@gmail.com> | 2022-08-04 16:40:44 +0200 |
|---|---|---|
| committer | Fabian Mastenbroek <mail.fabianm@gmail.com> | 2022-09-13 16:15:59 +0200 |
| commit | fdc3200ef4718eb98bd8a713f956222a9bf85ac9 (patch) | |
| tree | 4fa8e5998bd4ee59397b26222846c554b73abe4e /site/README.md | |
| parent | 8a94318aad4b4fa188ac49e887d564867a00111e (diff) | |
docs: Add initial version of Docusaurus based docs
This change updates the repository with a new Docusaurus-based
documentation website. This allows us to create our documentation using
Markdown, MDX and React. This will serve as the main entry point for
users visiting https://opendc.org. The actual OpenDC application will be
moved to https://app.opendc.org.
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. |
