This repository holds the WDAqua website. It uses Jekyll, hosted using Github Pages.

You'll find it easiest to make changes if you have Jekyll running locally so you can test whether the changes work. To do this:

1. Install Ruby 2.3.3 eg using rbenv to manage your Ruby versions

2. Clone the repo:

$ git clone https://github.com/WDAqua/wdaqua.github.io

3. Change directory into the new directory that's been made for the repo:

$ cd wdaqua.github.io

4. Install jekyll and bundler gems

$ gem install jekyll bundler

5. Run Jekyll locally. It will be served at http://localhost:4000/ by default.

$ bundle exec jekyll serve

You can then edit any of the files in wdaqua.github.io and the changes will automatically reflected in the locally served site.

When you've finished making changes, committing to the master branch of the repo will make the changes on the main website. Use a separate branch and a pull request for changes that you want someone else to check.

Student pages are kept as Markdown files within the _students directory. Simply edit that Markdown file to change it. The body of the Markdown file is the description of your project. Recognised metadata is:

Supervisor pages are kept as Markdown files within the _supervisors directory. Simply edit that Markdown file. The body of the Markdown file is your bio. Recognised metadata is:

Advisor pages are kept as Markdown files within the _advisors directory. Simply edit that Markdown file. If there's no home page for the advisor, the content can act as their bio. Recognised metadata is:

News/blog pages are kept as Markdown files within the news/_posts directory. Add new files for new items of news, using filenames in the form yyyy-mm-dd-title. Recognised metadata is: