README.md

The SERG website

The SERG web site is built with Jekyll and is running on GitHub pages.

Organization

The website is organized in six top level sections:

• People SERG member profiles
• Publications Auto-generated publication list
• Research Brief description and links to research lines; list of open projects.
• Teaching Links to our courses
• MSc projects Open research topics and previous master theses.
• Vacancies Open vacancies

Adding material

Material can be added by anyone in any section. We hereby provide some templates to make the look and feel more consistent.

Adding yourself to People

To add yourself to the People page, create a new file in the _people directory with the following content:

---
given_name:
surname:
interests:
current_affiliation: SERG
role:
start_date:
end_date:

website_url:
email:
github:
linkedin:
google_scholar:
xdotcom:
stackoverflow:
tudelft_research:
researchgate:
mastodon:
speakerdeck:
---

Also, add a picture of yourself to the img/people directory. The file name should match that of the markdown file, but with a .jpg extension. The picture should be square-ish and have a resolution of at least 200x200 pixels and less than 600x600 pixels.

Take a look at the existing files in the _people directory for examples.

Adding master thesis topics

Building locally

There are two options to build the website locally:

• Installing and running Jekyll
• Running Jekyll from a Docker container

Installing and running Jekyll

Jekyll requires Ruby (>=2.3). If you have Ruby installed (most recent Linuxes and Macs do have a correct version of Ruby), you can use the following commands to build the web site:

# Install dependencies
gem install bundler
bundle install

# Build the web site
bundle exec jekyll build

# Run jekyll as web server.
# Automatically rebuilds after a file change
bundle exec jekyll serve

Running with Docker

You can use Docker to avoid installing Ruby and/or gems. More instructions here

export JEKYLL_VERSION=3.8.4

# Build the web site
docker run --rm -p4000:4000 --volume="$PWD:/srv/jekyll" -it jekyll/builder:$JEKYLL_VERSION jekyll serve

Running with docker-compose

Docker Compose makes it even easier to start up the container. Run

docker compose up

Stop with Ctrl + C when done.