Skip to content

Latest commit

 

History

History
120 lines (98 loc) · 3.53 KB

README.md

File metadata and controls

120 lines (98 loc) · 3.53 KB

Bath RL website

Table of Contents:

  • I want to add myself to the website
  • I want to change my photo
  • I want to change my personal links
  • I want to add a paper
  • How do I run this locally

I want to add myself to the website

Add a photo in /assets/img/ with a simple title e.g. pani.jpeg. Create a folder with your name in /_profiles/ and inside add a markdown file (extension .md). Below is an example markdown file with all the supported fields:

---
name: Panayiotis Panayiotou (Pani)
linkedIn: https://www.linkedin.com/in/panispani
twitter: https://twitter.com/panispani
profileImg: pani.png
personalSite: https://panispani.com
scholar: https://scholar.google.com/citations?user=AfaKtVwAAAAJ
---

There is also a boolean "staff" field, to be only set for staff e.g. Ozgur.

I want to change my photo

Photos are in /assets/img/. Specify the right image path in your personal profile (these are located in /_profiles/ in a folder with your name, saved as a markdown .md file).

I want to change my personal links

Personal profiles are in /_profiles/. You need to add a folder with your name and inside a markdown file (.md at the end). For now all the supported fields are the following:

---
name: Panayiotis Panayiotou (Pani)
linkedIn: https://www.linkedin.com/in/panispani
twitter: https://twitter.com/panispani
profileImg: pani.png
personalSite: https://panispani.com
scholar: https://scholar.google.com/citations?user=AfaKtVwAAAAJ
---

There is also a boolean "staff" field, to be only set for staff e.g. Ozgur.

I want to add a paper

Papers are in /assets/papers.txt. The format of the file is just a collection of BibTeX entries. Just paste your BibTeX entry at the right chronological order. IMPORTANT: if you want to add a link to your paper add an extra field in BibTeX called "link". For example,

@article{evans2023creating,
  title={Creating multi-level skill hierarchies in reinforcement learning},
  author={Evans, Joshua B and {\c{S}}im{\c{s}}ek, {\"O}zg{\"u}r},
  journal={Advances in Neural Information Processing Systems},
  volume={36},
  pages={48472--48484},
  year={2023},
  link={https://proceedings.neurips.cc/paper_files/paper/2023/file/97b73904e88cc1dc0a3485595eda3753-Paper-Conference.pdf}
}

How do I run this locally

MacOs

# Install ruby. If you are not on Mac check the ruby website on how to install and add to your path.
brew install ruby
# Add to PATH.
echo 'export PATH="/opt/homebrew/opt/ruby/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc
# Verify install.
ruby -v
# Install packages
gem install bundler jekyll
# Make sure EXECUTABLE DIRECTORY is in your PATH
gem env
# Add EXECUTABLE DIRECTORY to PATH if it's not by adding this to .zshrc
export PATH="/opt/homebrew/lib/ruby/gems/3.3.0/bin:$PATH"
source ~/.zshrc
# Install dependencies
bundle install
# Build and serve
bundle exec jekyll serve

Linux

# Install Ruby (Debian/Ubuntu)
sudo apt update
sudo apt install ruby-full
# Verify installation.
ruby -v
# Install packages
gem install bundler jekyll
# Make sure EXECUTABLE DIRECTORY is in your PATH
# Run this command to find the path where gems are installed
gem env
# If the EXECUTABLE DIRECTORY is not in PATH, add it to .bashrc or .zshrc
# Replace /path/to/gem/bin with the actual path shown by `gem env`
echo 'export PATH="/path/to/gem/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc
# Install dependencies
bundle install
# Build and serve the Jekyll site
bundle exec jekyll serve

Misc

# Create a new Jekyll site in the current directory
jekyll new .