Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 2.71 KB

README.md

File metadata and controls

39 lines (28 loc) · 2.71 KB
Raw
layout title nav_exclude permalink seo
home
Just the Class
true
/:path/
type name
Course
Just the Class

Just the Class

Just the Class is a GitHub Pages template developed for the purpose of quickly deploying course websites. In addition to serving plain web pages and files, it provides a boilerplate for:

Just the Class is a template that extends the popular Just the Docs theme, which provides a robust and thoroughly-tested foundation for your website. Just the Docs include features such as:

Getting Started

Getting started with Just the Class is simple.

  1. Create a new repository based on Just the Class.
  2. Update _config.yml and README.md with your course information. Be sure to update the url and baseurl.
  3. Configure a publishing source for GitHub Pages. Your course website is now live!
  4. Edit and create .md Markdown files to add more content pages.

Just the Class has been used by instructors at Stanford University (CS 161), UC Berkeley (Data 100), UC Santa Barbara (CSW8), Northeastern University (CS4530/5500), and Carnegie Mellon University (17-450/17-950). Share your course website and find more examples in the show and tell discussion!

Local development environment

Just the Class requires no special Jekyll plugins and can run on GitHub Pages' standard Jekyll compiler. To setup a local development environment, clone your template repository and follow the GitHub Docs on Testing your GitHub Pages site locally with Jekyll.