Documentation

Documentation is located at https://physicsremotelab.github.io/documentation/

Local development setup using Docker

Build and run Docker container

docker compose up

Visit site on:

http://localhost:8080/documentation/

Local development setup without Docker

Download and install Ruby 3. Check if Ruby is installed.

ruby --version

Gem is used to install dependencies. Check if Gem is installed.

gem --version

Install Github Pages plugin, it contains Jekyll for static website creation and Bundler for dependencies.

gem install github-pages

Check if Jekyll and Bundler are installed

jekyll --version
bundler --version

Serve site

bundle exec jekyll serve

Visit site on

http://localhost:8080/documentation/