Skip to content

A UW theme for Jekyll based academic websites with the functionality of al-folio

License

Notifications You must be signed in to change notification settings

UW-Madison-DSI/uw-jekyll-theme

 
 

Repository files navigation

Logo

UW Jekyll Template

This is a Jekyll based website that is based upon the Al-Folio framework and incorporates styling from the standard UW HTML template.

UW Jekyll Template Home Page

Applications

The UW Jeckyll Template is intended to support the development of websites for the the following types of University of Wisconsin people and organizations:

  • department
  • lab
  • researcher or person
  • organization

Features

The UW Jeckyll Template has built-in support for the following capabilities:

  • blog
  • list of publications
  • list of projects
  • list of GitHub repositories
  • CV
  • teaching, description of course materials

Running

Simply run the following command to start the Jekyll app:

Local Setup (Standard)

Assuming you have Ruby and Bundler installed on your system:

sh run.sh

The application will be visible at the following url:

http://127.0.0.1:4000/uw-jekyll-theme/

Local Setup (Using Docker)

If you are running on Windows, we recommend that you run this application using Docker, which can be peformed as follows:

  • First, install docker and docker-compose.
  • Finally, run the following command that will pull a pre-built image from DockerHub and will run your website.
$ docker-compose up

Note that when you run it for the first time, it will download a docker image of size 300MB or so.

License

Distributed under the MIT License. See LICENSE for more information.

About

A UW theme for Jekyll based academic websites with the functionality of al-folio

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 83.3%
  • JavaScript 15.5%
  • SCSS 0.5%
  • CSS 0.4%
  • Shell 0.1%
  • TeX 0.1%
  • Other 0.1%