Build Instructions

This website uses the Jekyll static site generator, which is written in Ruby. To build this website, perform the following steps

1. Ensure that Ruby 3 is installed (Instructions).

   Note for MacOS users: We recommend that you do not modify the system-installed Ruby version, which may break scripts required by the OS. Instead install a copy of Ruby via Homebrew or Macports.

2. Ensure that you have the latest bundler version installed. On MacOS/Linux this can be done by typing:

gem install bundler

You may need to run as root using sudo at this step, depending on your setup.

3. Install Jekyll and other packages needed to build this website by invoking:

bundler config set --local path 'vendor/bundle'
cd /path/to/../AMLab-Amsterdam.github.io
bundler install

This will install all required packages into the subdirectory vendor/bundle of your working directory.

4. You should now be able to view the website by executing the following command:

bundler exec jekyll serve

This will start a webserver that allows you to view the website by accessing http://127.0.0.1:4000 in your browser.

Adding Your Personal Information

1. Clone the repository.

git clone [email protected]:AMLab-Amsterdam/AMLab-Amsterdam.github.io.git

2. Checkout a new branch with the following name:

• FirstnameLastnameNew if you are creating your personal page
• FirstnameLastnameUpdate if you are updating your existing personal page

3. Add the following files (details below):

• A description file ./_people/FirstnameLastname.md
• A profile picture ./assets/img/FirstnameLastname.[jpg/png]
• Optimally, a bibliography file ./_bibliography/FirstnameLastname.bib

4. Commit and push your changes to your newly created branch.

5. Open a pull-request on Github.

Description file

The description file FirstnameLastname.md takes the following format:

---
layout: person-page
first_name: John
middle_names: 
last_name: Doe
role: PhD candidate
email: [email protected]
office: Science Park 904, C1.234a 
lab: AMLab
institute: Institute of Informatics
university: University of Amsterdam
supervisors: [first supervisor, second supervisor, ... ]
one_liner: John's research interest in a nutshell
bib_file: JohnDoe
redirect: 
description: |
    Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

    Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

img: assets/img/JohnDoe.jpg
img_promo: 
personal_page: https://johnswebsite.doe
scholar_userid: XXXXXXXXXXXX
github_username: johns_github
twitter_username: johns_twitter
mastodon_username: johns_mastodon
mastodon_server: johns_server
category: PhD Students 
---

{% include person_page.html person=page %}

Mandatory fields:

• category (one of "Staff", "Postdocs", "PhD Students"; case sensisitive)
• first_name (string)
• last_name (string)
• email (this will be obfuscated automatically)
• role (string)
• lab (string)
• one_liner (string; truncated after 80 chars)
• img (filename)

Optional fields:

• middle_names (string)
• advisors (array of strings)
• office (string)
• institute (string)
• university (string)
• bibfile (filename; do not include .bib at the end)
• description (text)
• scholar_userid (string)
• github_username (string)
• twitter_username (string)

Image

Add a profile picture ./assets/img/FirstnameLastname.[jpg/png] (please keep the file size reasonably small). Please make sure the file name follows the naming conventions and matches the image file name in your description file.

Bibliography file

@InProceedings{bibid, 
  title = { ... },
  author = { ... },
  booktitle = { ... },
  ...
  abstract = { ... },
  html = { <Link to publication on venue's website> },
  pdf = { <Link to PDF> },
  abbr={ <Abbreviation of conference/journal, e.g. ICML> },
  code = { <Link to github/code> },
  video = { <Link to youtube> }
}

Note that html, pdf, abbr, code, video are not standard bibtex tags but are used to render additional content on the website. Please provide at least html, pdf, abbr and make sure the file name follows the naming conventions and matches the bibliography file name in your description file.

Information for maintainers

Check/Update the cutoff year in ./_includes/recent_papers.html to not show very old publications as 'recent' once a year.

Theme

The website uses al-folio, a simple, clean, and responsive Jekyll theme for academics. The theme is available as open source under the terms of the MIT License.