Documentation site for the Robotarium Cluster
This repo contains a Hugo based website, whose content
constitutes the documentation of the ECR Robotarium Cluster.
The repository has two branches, this (dev) and the Github Pages branch
master. All edits to the documentation site happen in dev, the master page
contains only the generated static content.
The website uses the Hugo Book theme as a
base, with some minor edits on top.
Contributions from cluster users are welcome (and encouraged)!
First clone the repo and load all submodules:
$ git clone git@github.com:ecr-cluster/ecr-cluster.github.io.git$ cd ecr-cluster.github.io/$ git submodule update --init # to get hugo-book theme# this part is important!$ git worktree add -B master public origin/master
The last command is especially important, as it checkouts the publishing branch
into the directory public. This ensures that when calling Hugo, that the
generated content goes to the right place.
After this, edit the site anyway you want. Once complete, post a PR so that your
changes can be merged in.
This site includes content that might belong to others, it is unclear how to
properly handle this.
The logo/favicon are the property of the ECR.