jpraw / opta-docs

The Opta Documentation

Latest Main (edge) Deploy: https://edge.docs.opta.dev

Development

Traditional

1. Fetch git submodules: git submodule update --init --recursive
2. Install hugo: brew install hugo
3. Install npm dependencies: npm install
4. Run hugo server: hugo server

Docker-compose

1. Fetch git submodules: git submodule update --init --recursive

2. Install docker-compose and

   docker-compose up

You can now see the site at http://localhost:1313 Any changes you make will get instantly updated in the browser!

Deployment

We have continuous deployment set up. Once your PR gets merged, it will automatically get deployed to https://docs.opta.dev