Skip to content

harvard-intouch/harvard-intouch.github.io

Repository files navigation

InTouch Website

This is the InTouch website, built on top of the academicpages template.

Adding new member profiles

Find and edit your entry in _data/people.yml, which should look something like this:

- name: (your name, e.g. Knickerbocker Thaddeus P. Flufferkins)
  site: (your optional personal website, e.g. https://youtu.be/oHg5SJYRHA0)
  email: (your email)
  title: (your title, e.g. Extremely Tired PhD Candidate)
  image: (a link to your 400x400 picture, e.g. /images/people/flufferkins.png)
  blurb: |-
    (an optional very short description of your work that will appear on hover)

Personal images should be square, 400 by 400 pixels, and uploaded to the ./images/people directory. Please compress images down using [this compressor](https://imagecompressor.com/, https://www.resizepixel.com/edit) so the site loads quickly.

Modifying the website's content

The _pages directory has all of the pages on InTouch's website. Each one is written using "markdown" -- if you're not familiar with it, markdown is a quick way to format a webpage without needing to know anything about HTML/CSS/JS.

Have my changes worked?

If you go to the "Actions" tab above, you'll see whether your most recent changes are still being deployed, whether they have an error, or whether they've been successfully deployed.

Adding additional pages

To add additional pages to the website, create a new HTML or markdown file under _pages/, e.g. _pages/mypage.html or _pages/mypage.md.

The first five lines of this new file should be:

---
layout: archive
title: "My new page title"
permalink: /mypage/
---

where the permalink field matches the file name. Then you can fill in the rest of the page with whatever content you want!

If you want this page to appear in the top-level navigation, you can edit _data/navigation.yml and add a new entry for the new page, e.g.:

- title: "My New Page"
  url: /mypage/

To run locally (not on GitHub Pages, to serve on your own computer)

Although you can make the above edits through the Github web interface if you wish, it's better if you can get it running locally on your computer to confirm your changes have the intended effect before committing to master (which will automatically deploy the site). Here are instructions for how to do that:

  1. Clone the repository and cd into the directory
  2. Make sure you have ruby and node installed
    • On Linux, something like sudo apt install ruby-dev ruby-bundler nodejs should work
    • On Mac, if you've installed homebrew, brew install ruby and brew install node should hopefully do the trick (though using a Ruby version manager like rbenv is recommended if slightly more complicated)
    • Run gem install bundler if you've just installed (a new version of) Ruby
  3. Run bundle install to install Ruby dependencies.
  4. Run bundle exec jekyll serve to generate the HTML and serve it from localhost:4000. The local server will automatically rebuild changed pages, though it may take a few seconds and require refreshing.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published