Jekyll Course Website Template

Overview

This product is a Jekyll course website template that allows users to create and customize their own course websites. It is lightweight, highly customizable and responsive, making it ideal for use with GitHub Pages. It features individual pages for assignments, lectures, course materials, and course schedule. It also includes automatic generation of course updates sections and custom/manual announcements. The template has a new schedule page with more efficient use of space and supports themes for modifying the website’s look according to a school’s branding.

Features

• Individual pages for assignments, lectures, course material, and course schedule
• Auto generated Course schedule Page
• Auto generated course updates section (for each new lectures and assignments) + custom/manual announcements
• Super lightweight
• Highly customizable
• Ready to be used in Github Pages
• Responsive Mobile View
• Support for Google Analytics

Installation

To deploy your own website using this template on GitHub Pages, follow the steps below:

1. Fork this repository.
2. Open _config.yml and update the url field according to your GitHub account (e.g., https://<your-github-username>.github.io/).
3. Update the baseurl field according to your repository’s name (e.g., /cs101).
4. Commit and push your changes.
5. Go to your repository’s settings (https://github.com///settings).
6. In the GitHub Pages section, choose the source to be your master branch and enable GitHub Pages.
7. You are now ready to go! Start customizing your website.

Pro Tip: You can update your website’s source files using the GitHub web UI without cloning your repository. GitHub will automatically build and deploy your website.

Best Practice for managing repositories: If you plan to use this template for university courses offered in multiple semesters/quarters, it is recommended to create a separate GitHub account or an Organization for it. Then, create a new repository under that account/organization for each semester.

Example:

• Course name: CS101
• Semester: Fall 2020
• School name: CMU
• Account/Organization name: cmu-cs101
• Repo name: fa2020
• Website address: https://cmu-cs101.github.io/fa2020/

Summary

The Jekyll course website template is a lightweight and highly customizable product for creating course websites. It provides individual pages for various course components, automatic generation of course updates sections, and customizable announcements. The template is designed to work well with GitHub Pages and offers a responsive mobile view. It also supports Google Analytics for tracking website usage. With easy installation and customization options, it is an ideal choice for creating course websites.