generated from kevinlin1/just-the-class
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
d7b4bfe
commit dc77c7e
Showing
1 changed file
with
2 additions
and
36 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,39 +1,5 @@ | ||
--- | ||
layout: home | ||
title: Just the Class | ||
nav_exclude: true | ||
permalink: /:path/ | ||
seo: | ||
type: Course | ||
name: 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: | ||
|
||
- [announcements](announcements.md), | ||
- a [course calendar](calendar.md), | ||
- a [staff](staff.md) page, | ||
- and a weekly [schedule](schedule.md). | ||
|
||
Just the Class is a template that extends the popular [Just the Docs](https://github.com/just-the-docs/just-the-docs) theme, which provides a robust and thoroughly-tested foundation for your website. Just the Docs include features such as: | ||
|
||
- automatic [navigation structure](https://just-the-docs.github.io/just-the-docs/docs/navigation-structure/), | ||
- instant, full-text [search](https://just-the-docs.github.io/just-the-docs/docs/search/) and page indexing, | ||
- and a set of [UI components](https://just-the-docs.github.io/just-the-docs/docs/ui-components) and authoring [utilities](https://just-the-docs.github.io/just-the-docs/docs/utilities). | ||
|
||
## Getting Started | ||
|
||
Getting started with Just the Class is simple. | ||
|
||
1. Create a [new repository based on Just the Class](https://github.com/kevinlin1/just-the-class/generate). | ||
1. Update `_config.yml` and `README.md` with your course information. [Be sure to update the url and baseurl](https://mademistakes.com/mastering-jekyll/site-url-baseurl/). | ||
1. Configure a [publishing source for GitHub Pages](https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages). Your course website is now live! | ||
1. Edit and create `.md` [Markdown files](https://guides.github.com/features/mastering-markdown/) to add more content pages. | ||
|
||
Just the Class has been used by instructors at Stanford University ([CS 161](https://stanford-cs161.github.io/winter2021/)), UC Berkeley ([Data 100](https://ds100.org/fa21/)), UC Santa Barbara ([CSW8](https://ucsb-csw8.github.io/s22/)), Northeastern University ([CS4530/5500](https://neu-se.github.io/CS4530-CS5500-Spring-2021/)), and Carnegie Mellon University ([17-450/17-950](https://cmu-crafting-software.github.io/)). Share your course website and find more examples in the [show and tell discussion](https://github.com/kevinlin1/just-the-class/discussions/categories/show-and-tell)! | ||
|
||
### Local development environment | ||
# Data 88E Economic Models | ||
|
||
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](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll). | ||
This repo hosts the Fall 2024 website for Data 88E. It is based on Just the Class. |