search

jku-vds-lab / jku-vds-lab.github.io

JKU Visual Data Science Lab Website
https://jku-vds-lab.at/
BSD 3-Clause "New" or "Revised" License
0 stars 5 forks source link

readme

JKU Visual Data Science Lab Website

htmlproofer

The new Visual Data Science Lab Website built with Jekyll, SASS, Bourbon, Neat, and Bitters.

Emulating github-pages

Ruby

The site is built by Github using Jekyll. To preview locally, use the github-pages gem. Briefly:

# Ruby version must be >= 2.0.0.
ruby --version
# Install bundler for dependency management:
gem install bundler
# Fetch dependencies:
bundle install
# Start server:
bundle exec jekyll serve --baseurl ""
# Get the most recent version of 'github-pages' gem:
bundle update

More information

Docker

You can use docker to build and run the site without having to install ruby and stuff. This will also watch for file changes and rebuild the site automatically.
Page will be served at localhost:4000

docker-compose up

To simply build the page, run

docker run --rm --volume="$PWD:/srv/jekyll" -it jekyll/jekyll:latest jekyll build

Jekyll Plugins

The only supported plugins are those that come with the github-pages gem.

Liquid Syntax

Liquid for Designers

Adding a Publication/Paper

You should use the template provided in ./templates/paper-template.md for adding a new publication. Preprints will be rendered in a separate section, therefore make sure to update and remove it after publication (update bibtex section as well).

Each publication should be assigned an unique key like: YYYY_CONFSHORTNAME_PAPERSHORTNAME

This string will be the part of the URL referencing this publication.

Instructions for adding a new publication

  1. Copy the template ./templates/paper-template.md into the folder ./_publications/.md.
  2. Choose a publication type, currently either paper, preprint or thesis and fill in the abstract
  3. You should provide two images, one teaser (1200x600 ~300KB) and one thumbnail (400x200 ~70kb) to the assets/images/papers, you should use the key as defined above as part of the filename.
  4. (optional) Upload all your videos relevant to the publication to the ICG Vis Lab YouTube Channel, and fill the template's videos section with the video's Youtube-ID
    • If you have any slides relevant to the video, upload them alongside your paper PDF as well
  5. Provide all authors as a collection/list - if the author is a team member that has a separate page, provide the key instead of firstname/lastname, e.g. streit
  6. fill in the other fields as required/available, most are optional and can be left empty
  7. Upload the following files to the data AWS S3 Bucket within '/papers':
    • publication as PDF (KEY.pdf)
    • (optional) Supplementary Material/Slides/etc. (KEY_<CUSTOM>.<CUSTOMEXT>)

Instructions for adding a new team member

  1. Copy the template ./templates/person-template.md into the folder ./_persons/.md.
  2. Fill in mandatory fields, first_name, last_name, title, key, email, organization, position
  3. Choose a role (faculty, raPHD, undergrad, phdgrad, alumni)
  4. Add a profile image to the folder ./assets/images/team_colored/.jpg
  5. (optional) provide your degrees, office location, phone number, twitter handle, github username, Google scholar key, linkedin username, URL to your CV, URL to your thesis, URL to your website
  6. (optional) if you have many publications, you may want to set show_pub_nav to true, which enables a submenu for your team page
  7. Finally, add your profile content/text