Skip to content

dtak/dtak.github.io

Repository files navigation

DtAK Lab Website

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

To add your publications

Update _data/publications.yml to include a new YAML array entry of the form:

- title: UnICoRn: Unsupervised Interpretable COol RepresentatioNs
  year: 2020
  authors: me, you, and Finale Doshi-Velez
  venue: Yaniv's International Conference on Unsupervised Probability
  links:
    - text: "pdf"
      url: https://arxiv.org/pdf/XXXX.YYYYY.pdf
    - text: "code"
      url: https://github.com/dtak/ZZZZZZ

The links section is a sub-array where you can list any number of links (which will appear in brackets at the end of the entry, with your specified text and url). For consistency, we recommend using pdf to link directly to the paper PDF, link to link to the paper in the context of its publication venue, and code to link to an associated Github repository.

Note that the list is not automatically sorted, so please try to insert your publication in the appropriate place chronologically!

To update your profile

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)
  title: (your title, e.g. Extremely Tired PhD Candidate)
  image: (a link to your 400x400 picture, e.g. /images/people/flufferkins.png)
  hover: (a link to an easter egg picture that will be overlaid on hover, e.g. /images/pony_blue.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. You can compress images down to 400x400 using this compressor if you need.

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.

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/