Skip to content

Latest commit

 

History

History
71 lines (46 loc) · 3.69 KB

README.md

File metadata and controls

71 lines (46 loc) · 3.69 KB
Raw

Control and Learning for Autonomous Robotics (CLeAR) Lab Page

This is the repository for the CLeAR lab page. The site is based on Jekyll and uses GitHub Pages. The site is based upon the template used by the Kording Lab at UPenn. Thanks!

Run the page locally using Jekyll

To run locally, follow instruction here to install Jekyll then run jekyll serve to see in localhost:4000. Here is a brief install guidelines.

sudo gem install jekyll
sudo gem install rouge
jekyll serve

Editing the lab website

Below, we explain how to edit the lab webpage

Add yourself

You can add yourself to the page in the _people folder. Create a file named <firstname>_<lastname>.md in the folder. We require a few line of header before you start writing your own page, e.g.

---
name: James Kirk
position: gradstudent
avatar: james_kirk.jpg
joined: 2021
---

If you don't have information, just leave it blank. Add a photo of yourself to the images/people folder; this will be displayed on the people page. For lab position, you can choose position from 4 classes including postdoc, gradstudent, visiting, others. The site generator will automatically sort you into that section.

Add your publications

Copy the BibTex entry of your paper from Google Scholar and paste it in _bibliography/references.bibsomewhere after the header. Make sure to include PDF and video links as relevant; you can find examples in the aforementioned file. Also, please create a news item (see below) announcing your paper and providing a link to the PDF and any other supplementary material you wish to publicize.

Add news

All news presented in the front page by editing _data/news.yml. There are some symbols that cannot be used directly e.g. :, be careful!

Publish an update

If you're part of the CLeAR lab GitHub organization and you've made a change, reviewed and merged a pull request into the develop branch, you can do the following to publish your updates to the website. This assumes you have a local version of this repository on your computer.

  • git pull the most recent merged changes locally
  • rake publish to convert the files in the develop branch to a static site in the master branch. This automatically calls a GitHub action to deploy the contents of master branch to https://clearoboticslab.github.io