This website is generated using the static site generator (SSG) Jekyll. Unfortunately Jekyll has limited support for the Windows operating system, and requires a rather involved set-up of Ruby as well as some management of Ruby packages called "Gems". Knowledge of the Ruby programming langauge itself is not required, however a solution that makes use of a more familiar programming language to physics researchers (such as Python, or Julia) may be better for long term maintainability. On the plus side, Jekyll is the "default" SSG for Github pages and is thus well integrated, and support is easy to find online owning to its widespread use.
The theme used is Minimal Mistakes with some minor modifications.
These modified .html files are listed in _include and the modified .css is appended to the file src/assets/css/main.css.
This website is automatically published and hosted via Github pages provided the repository settings allow for this. The website can also be tested locally by first cloning the repository, and then running
bundle exec jekyll servein the root directory.
This will create a directory _site in the root directory which should not be tracked by git and is therefore included in the .gitignore file.
One can then view the website in the browser at the address http://localhost:4000.
Pages can be either written in markdown (recommended) or HTML. To contribute to this website, you should first fork the repository, then
git pullto sync your fork with this repository (perhaps others have contributed since your last contribution),- make and commit your changes,
- test the website locally using the command above,
- open a pull request to the main repository which will be reviewed and eventually merged.
You should never contribute directly to the main branch of this repository (there are measures in place to prevent this) as this is the branch that automatically gets published.