mlinpl-jekyll-theme

This repository contains the Jekyll theme developed for the ML in PL websites (conferences, summer schools etc.).

Resources

• Jakyll tutorial: https://jekyllrb.com/docs/step-by-step/01-setup/
• GitHub pages docs: https://docs.github.com/en/pages

Project structure

• _data - contains yml files with data
• _includes - contains different modules that can be included
• _layouts - contains full layouts for the page
• _posts - contains blog posts
• images - contains different images used on the site
• libs - contains external libraries
• scripts - contains scripts used for different tasks like generating optimized images, building the site etc.

Quick-start - running this repo locally

Install deps

Ubuntu:

First setup rbenv according to the official github page: https://github.com/rbenv/rbenv. Don't install the version provided in the distro's repo. Follow the official rbenv instructions to install the latest Ruby version and set it as the default interpreter.

Now you should be able to run ruby and gem:

$ ruby --version
ruby 3.0.2p107 (2021-07-07 revision 0db68f0233) [x86_64-linux-gnu]
$ gem
3.4.5

Now you can run the following in the project's root to install bundler (ruby's version of venv) and the correct gems.

gem install jekyll bundler
bundle install

Mac:

brew install chruby ruby-install xz
ruby-install ruby
echo "source $(brew --prefix)/opt/chruby/share/chruby/chruby.sh" >> ~/.zshrc
echo "source $(brew --prefix)/opt/chruby/share/chruby/auto.sh" >> ~/.zshrc
echo "chruby ruby" >> ~/.zshrc
source ~/.zshrc # or restart your session
gem install jekyll bundler

Then:

bundle install

Windows:

1. Install RubyInstaller with DevKit from https://rubyinstaller.org/. Follow the step-by-step instructions and install the default components.
2. Open a command prompt or PowerShell window and navigate to the project directory.
3. Install the required dependencies by running the following commands:

gem install jekyll
gem install bundler -v '2.4.5'
bundle _2.4.5_ install

Note: By default, bundle install may try to run a bundle.js file in your root directory. If this happens, you may want to move this file temporarily.

Run server with livereload

bundle exec jekyll serve --livereload

This should start the server and make your website available at http://localhost:4000.

To run server with config for a conference site use:

bash serve_conference.sh

To run server with config for a summer school site use:

bash serve_mlss.sh

Optimizing images