StARLinG Lab

Overview

StARLinG Lab's website hosted on GitHub Pages. Built with Jekyll, jQuery, and the minimal-mistakes Jekyll theme.

Maintained by Alexander L. Hayes and Harsha Kokel.

Contact: {alexander.hayes/harsha.kokel}@utdallas.edu

Quick-start Guide (Linux and OSX)

• Install Ruby and RubyGems (refer to Jekyll installation and quick-start guide).
• git clone https://github.com/starling-lab/starling-lab.github.io.git
• gem install jekyll bundler
• bundle install
• bundle exec jekyll serve
• Navigate to 127.0.0.1:4000 in your browser.

Publishing the Website

The website is automatically deployed to GitHub Pages via GitHub Actions when changes are pushed to the main/master branch.

Automatic Deployment Process

1. Make your changes locally
2. Test with bundle exec jekyll serve
3. Commit and push to the repository (or merge a PR to main/master)
4. GitHub Actions will automatically build and deploy the site
5. The site will be available at: https://starling-lab.github.io

Manual Deployment

You can also trigger a manual deployment from the Actions tab in GitHub.

Configuration

• The deployment workflow is defined in .github/workflows/jekyll.yml
• GitHub Pages must be configured to use GitHub Actions as the source (in repository settings)
• The workflow uses Ruby 3.1 for better compatibility with GitHub Pages dependencies

Updates guide

1. Publications are in /_data/publication.yml
2. News updates go in /_news/...
3. Lab member details are in /_data/authors.yml
4. Gallery photos are in /_pages/photo-gallery.md
5. Top navigation is in /_data/_navigation.yml

Contributing

Refer to CONTRIBUTING.md for documentation on submitting issues and pull requests.

A Guide to Updating the Website has more information on how to author new pages, and the same directory has templates that may be useful.

License

This work is licensed under a Creative Commons Attribution 4.0 International License. See LICENSE.txt for a full copy of the license.

Attribution

This work incorporates work from the following sources:

• "Minimal Mistakes" a Jekyll theme by Michael Rose and contributors, distributed under the terms of the MIT License.
• "jekyll" a blog-aware, static site generator in Ruby, distributed under the terms of the MIT License.
• "linkprediction.jpg" is plotted and rendered with Cytoscape, used under the terms of the LGPL.
• The random student loading on the homepage is based on a blog post by James W Thorne.
• The StARLinG Logo is designed by Gautam Kunapuli, and used with permission.