Skip to content

Latest commit

 

History

History
41 lines (37 loc) · 2.95 KB

README.md

File metadata and controls

41 lines (37 loc) · 2.95 KB
Raw

Table of Contents

Local Development

  1. Follow the instructions here to install ruby, jekyll, and bundler
  2. Clone down your fork git clone git@github.com:chai-toronto/chai-toronto.github.io.git
  3. Serve the site and watch for markup/sass changes bundle exec jekyll serve
  4. View your website at http://127.0.0.1:4000/
  5. Commit any changes and push everything to the master branch of your GitHub user repository. GitHub Pages will then rebuild and serve your website.

Updating Your Profile

Edit Metadata

Add an entry to _data/members.yml with the following fields:

Field Required Details
id yes Should usually be formatted as lastname_firstname. This is what you'll use throughout the site to refer to yourself and link to your homepage.
name yes Full name
affiliation yes Departmental program
image yes Path to your profile picture. Images should be square and ideally 165x165px.
website yes Full link to your personal website
degree yes The shorthand name of your degree, such as PhD, MSc, or BS
active yes Put true if you are currently working in the lab or false if you are now working elsewhere

Upload image

Images should be uploaded to images/members/. Images should be square and (ideally) 165x165px. If you upload something else, it will be cropped.

Adding a Publication

Create a new file in _publications/. The file should have the following fields:

Field Required Details
title yes Verbatim paper title
authors yes This should be a list of full names. If an author is a lab member (or former lab member), use the member's id instead of their name to link it to their website.
venue yes Full name of the publication venue. If it is a common name, look in _data/venues.yml to see if a shortcut has been defined. If so, you can use the shorthand name (including the $ delimiters) and the full name will automatically be used. You can mix shorthand names with other text if you need to specify that it was submitted to a workshop or alternative track.
date yes Publication/presentation date
link yes External link to the ACM DL or equivalent
thumbnail yes Must be 16x9 and 300px wide. Add to images/pubs/.
award no The name of the award the paper received (e.g., 'Best Paper Award' or 'Honorable Mention Award')
news no List of different press releases, which contains
  • name: the name of the news entity
  • url: the url to the article
  • headline: the headline
  • date: the date the article was published
video_embed no HTML embed code for video player