Skip to content

schrilax/research-group-web

 
 

Repository files navigation

Research Group Web Site Template

This is a Jekyll-based Web site intended for our research group.

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

Publication List

The list of publications is in bib/pubs.bib. Typing make will generate pubs.html, which contains a pretty, sorted HTML-formatted list of papers. The public page, publications.html, also has a link to download the original BibTeX.

News Items

The file must begin with YAML front matter. For news updates, use this:

---
layout: post
shortnews: true
---

Personnel

People are listed in a YAML file in _data/people.yml. You can list the name, link, bio, and role of each person. Roles (e.g., "Faculty", "Staff", and "Students") are defined in _config.yml.

Building

The requirements for building the site are:

  • Jekyll: run gem install jekyll
  • Pybtex: run pip install pybtex
  • bibble: included as a submodule. Because git is cruel, you need to use git clone --recursive URL or issue the commands git submodule init ; git submodule update to check out the dependency.
  • ssh and rsync, only if you want to deploy directly.

make compiles the bibliography and the website content to the _site directory. To preview the site, run `jekyll serve`` and head to http://0.0.0.0:4000.

Deploying to Your Sever

To set up deployments, edit the Makefile and look for the lines where HOST and DIR are defined. Change these to the host where your HTML files should be copied to.

To upload a new version of the site via rsync over ssh, type make deploy. A web hook does this automatically when you push to GitHub. Be aware that the Makefile is configured to have rsync delete stray files from the destination directory.

About

a template for research group sites

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TeX 51.7%
  • HTML 24.3%
  • CSS 10.3%
  • JavaScript 7.1%
  • Perl 4.2%
  • Makefile 2.4%