Skip to content

How to work on the public web site

Our main site is https://opentrack.run/

This is a static site build in GitHub Pages.

Via GitHub's web interface

If you have access, you can directly navigate to a source page and click the pencil (edit) icon, edit and commit.

You can also create new files this way; this is an easy way to create new news items.

Committing results in Github Pages re-publishing, usually within a minute.

Setting up a local copy

Github Pages uses the Jekyll static site generator, which uses the Ruby language. Once a suitable Ruby is running, installation is a few commands. Best to start here: https://jekyllrb.com/docs/

Unfortunately if you aren't a Ruby developer this can be fiddly, as there might be a system Ruby version you don't know about somewhere

Instructions below worked for each of us some time in the past, but check the public Jekyll and Ruby install docs first

Editing through the web

Luckily, simple text edits and new textual pages can be edited in a browser with the pencil tool in the Git repo. They should usually show up live in anywhere from 1 to 15 minutes.