Skip to content

wychowlab/wychowlab-web

Repository files navigation

Website for Wing Ying Chow's Lab at University of Warwick, UK

https://wychowlab.org/

Background

This is a Jekyll-based Web site based on the work of the sampa group at the University of Washington. It was forked from this repository and detached after significant modifications.

This work is licensed under a Creative Commons Attribution-NonCommercial 4.0 International License.

Modifications from uwsampa template

  • adapted and optimized the build process for GitHub Pages
  • improved .gitignore using Toptal's gitignore tool
  • added Gemfile for a consistent Jekyll build environment using Bundler
  • added jekyll-seo-tag plugin, mostly for improved Twitter cards
  • added jekyll-feed and jekyll-sitemap plugins
  • updated from [Bootstrap][] 3 to 5
  • updated from [Font Awesome][fa] 4 to 6, originally for the ORCID logo, but possibly now more for the fun effects
  • updated from jQuery 3.5.1 to 3.6.1
  • added favicon generated from fontawesome
  • used pylatexenc to convert LaTeX-encoded parts of website back to text
  • refactored parts of default.html/index.html as includes
  • typography: test with Fontjoy, served with Google web fonts
  • implemented some accessibility provisions such as alt tags for images and screen readers (aria)
  • renamed master to main (see github/renaming)
  • removed "faculty" as being used for a single-PI lab website
  • added lightbox
  • implemented a covers gallery on the publication page
  • implemented checking for broken links using html-proofer (gem)

Building

The requirements for building the site are now:

  • [[ruby]] - I used the snap. snap info ruby followed by snap install ruby --classic (works with ruby 3.4.7). This provided ruby.bundle
  • Based on the Gemfile, run ruby.bundle install. This installs Jekyll and other modules required. You can comment out parts you don't want.
  • bibble: available on pip and I decided to use pipx install bibble
  • pylatexenc: I decided to use pipx install pylatexenc
  • ssh and rsync, only if you want to deploy directly.

make build compiles the bibliography and the website content to the docs directory. To preview the site, run make serve and head to http://localhost:4000.

Note: I do not regularly use ruby and only use python in very specific cases. There are probably better ways to set up your build environment if you use these frequently.

Deploying to GitHub Pages

This template is optimized for hosting the site on GitHub Pages using a custom domain in CNAME. You can pick which branch you deploy the site on. A new commit/push to GitHub will trigger a rebuild.

About

Wing Ying Chow (Warwick, UK) lab website. Using magnetic resonance to deliver new insight to human health and disease.

Topics

Resources

License

Stars

Watchers

Forks

Contributors