realliyifei/penn-nlp.github.io

How to make any changes to the website

If you want to make any changes to the website, first fork the repository, make your changes to your forked version, and then submit a pull request.

How to add someone to the people page

To add a new person to the people page (/people.html), add a new entry to _data/people.yml. The names should be sorted in alphabetical order by last name, regardless of their position.

How to add a photo

To add a photo of yourself or another person, put the photo into assets/img and follow the filename pattern. Then, add or update your entry in _data/people.yml to point to your new photo. The photos are displayed at 170px by 170px. See this pull request for an example.

How to add someone to the alumni page

To add a new person to the alumni page (/alumni.html), create a new entry in _data/alumni.yml. The entries should be sorted by graduation year followed by last name.

How to run the website locally

Before submitting a pull request, it would be great if you can test that your changes didn't inadvertently break the web site. You can test the website locally by running jekyll in your penn-nlp.github.io/ directory.

First, you'll need to get the jekyll dependencies that we use. You should only need the run these once:

gem install bundler
gem install github-pages
gem install nokogiri -v '1.10.4' 
bundle update
bundle install

Whenever you make changes to the web site content, you can run this command to test the website locally:

bundle exec jekyll serve

You can then point your web browser to http://127.0.0.1:4000 to look at your changes.

If you're interested in learning more about Jekyll, you can read this Jekyll tutorial.