Oktopus Documentation Site

This is the repository of the Oktopus Documentation Site.

Public link to the site.

Getting started

Oktopus Documentation Site is a static site build with Jekyll. Jekyll provides a Docker container to quickly build the site. First get the Docker image by running:

docker pull jekyll/jekyll

Then build the site by running:

export JEKYLL_VERSION=3.8
docker run --rm \
  --volume="$PWD:/srv/jekyll" \
  --volume="$PWD/vendor/bundle:/usr/local/bundle" \
  -it jekyll/jekyll:$JEKYLL_VERSION \
  jekyll build

To test the site locally, run:

docker run --rm \
  -p 4000:4000 \
  --volume="$PWD:/srv/jekyll" \
  --volume="$PWD/vendor/bundle:/usr/local/bundle" \
  -it jekyll/jekyll:$JEKYLL_VERSION \
  jekyll serve

Afterward, open your browser at http://localhost:4000.