README.md

How Jon Uses This Repository

• Create a branch based on the year and semester (e.g. 2023f)
• Make changes to that branch only!
• In Settings -> Pages -> Build and Deployment, choose the current branch as the deployment target. This should get the current year to build at https://jonmay.github.io/USC-CS662

How to Archive and Start a New Class

• clone this repository locally, naming it for the most recent previous class (e.g. /Users/jonmay/projects/cs662/24/USC-CS662-23)
  • git clone [email protected]:jonmay/USC-CS662.git USC-CS662-23
• create a new github repository at https://github.com/new with name USC-CS662-XX where XX is the most recent previous class
• in the local repository do the following:
  • git fetch --all
  • git checkout -b 20XXf origin/20XXf (where XX is the most recent previous class year)
  • edit .git/config and remove the block for [remote "origin"] (i.e. that header and its indented lines)
  • git remote add origin [email protected]:jonmay/USC-CS662-XX.git (where XX is the most recent previous class; the content after origin can be copied from the github creation page)
  • git push -u origin 20XXf (where XX is the most recent previous class year)
• In the newly created github repository at https://github.com/jonmay/USC-CS662-22/settings/pages select the 20XXf branch
• Modify your webpage to point the most recent class to https://jonmay.github.io/USC-CS662-XX/
• Create a new entry pointing the current year class to https://jonmay.github.io/USC-CS662/
• See above for making sure the deployment target is the current year

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:

• a course calendar,
• a staff page,
• and a weekly schedule.

Just the Class is built on top of Just the Docs, making it easy to extend for your own special use cases while providing sane defaults for most everything else. This means that you also get:

• automatic navigation structure,
• instant, full-text search and page indexing,
• and a small but powerful set of UI components and authoring utilities.

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 index.md with your course information.
3. Configure a publishing source for GitHub Pages. Your course website is now live!
4. Edit and create .md Markdown files to add your content.

For a few open-source examples, see the following course websites and their source code.

• CSE 390HA (source code) is an example of a single-page website that centers modules.
• CSE 143 (source code) hosts an entire online textbook with full-text search.
• CSE 373 (source code is an example of a simple website combining Markdown pages with generated HTML files.

Share your website with us in the show and tell discussion!

Continue reading to learn how to setup a development environment on your local computer. This allows you to make incremental changes without directly modifying the live website.

Local development environment

Just the Class is built for Jekyll, a static site generator. View the quick start guide for more information. Just the Docs requires no special Jekyll plugins and can run on GitHub Pages' standard Jekyll compiler.

1. Follow the GitHub documentation for Setting up your GitHub Pages site locally with Jekyll.
2. Start your local Jekyll server.

$ bundle exec jekyll serve

1. Point your web browser to http://localhost:4000
2. Reload your web browser after making a change to preview its effect.

For more information, refer to Just the Docs.