Skip to content

Commit bbd9862

Browse files
dwzhu-pkudwzhu-pku
committed
Initial commit
0 parents  commit bbd9862

36 files changed

+1164
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Ask a question
4+
url: https://github.com/kevinlin1/just-the-class/discussions
5+
about: Ask questions and discuss with other community members

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.gitignore

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
*.gem
2+
.bundle/
3+
.jekyll-cache/
4+
.jekyll-metadata
5+
.sass-cache/
6+
Gemfile.lock
7+
_site/
8+
node_modules/
9+
vendor/

‎Gemfile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
source 'https://rubygems.org'
2+
gem 'github-pages', group: :jekyll_plugins

‎LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2019 Kevin Lin
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Just the Class
2+
3+
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:
4+
5+
- a [course calendar](calendar.md),
6+
- a [staff](staff.md) page,
7+
- and a weekly [schedule](schedule.md).
8+
9+
Just the Class is a set of customizations on top of the popular [Just the Docs](https://github.com/pmarsceill/just-the-docs) theme, which provides a robust and thoroughly-tested foundation that makes it easy to extend for your own special use cases. These foundational features include:
10+
11+
- automatic [navigation structure](https://pmarsceill.github.io/just-the-docs/docs/navigation-structure/),
12+
- instant, full-text [search](https://pmarsceill.github.io/just-the-docs/docs/search/) and page indexing,
13+
- and a small but powerful set of [UI components](https://pmarsceill.github.io/just-the-docs/docs/ui-components) and authoring [utilities](https://pmarsceill.github.io/just-the-docs/docs/utilities).
14+
15+
## Getting Started
16+
17+
Getting started with Just the Class is simple.
18+
19+
1. Create a [new repository based on Just the Class](https://github.com/kevinlin1/just-the-class/generate).
20+
1. Update `_config.yml` and `index.md` with your course information.
21+
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!
22+
1. Edit and create `.md` [Markdown files](https://guides.github.com/features/mastering-markdown/) to add your content.
23+
24+
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 ([DS1](https://ucsb-ds.github.io/ds1-f20/)), 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/)). For a few open-source examples, see the following course websites and their source code.
25+
26+
- [CSE 390HA](https://courses.cs.washington.edu/courses/cse390ha/20au/) ([source code](https://gitlab.cs.washington.edu/cse390ha/20au/website)) is an example of a single-page website that centers modules.
27+
- [CSE 143](https://courses.cs.washington.edu/courses/cse143/20au/) ([source code](https://gitlab.cs.washington.edu/cse143/20au/website)) hosts an entire online textbook with full-text search.
28+
- [CSE 373](https://courses.cs.washington.edu/courses/cse373/21su/) ([source code](https://gitlab.cs.washington.edu/cse373-root/21su/website)) is an example of a simple website combining Markdown pages with generated HTML files.
29+
30+
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)!
31+
32+
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.
33+
34+
### Local development environment
35+
36+
Just the Class is built for [Jekyll](https://jekyllrb.com), a static site generator. View the [quick start guide](https://jekyllrb.com/docs/) for more information. Just the Docs requires no special Jekyll plugins and can run on GitHub Pages' standard Jekyll compiler.
37+
38+
1. Follow the GitHub documentation for [Setting up your GitHub Pages site locally with Jekyll](https://help.github.com/en/articles/setting-up-your-github-pages-site-locally-with-jekyll).
39+
1. Start your local Jekyll server.
40+
```bash
41+
$ bundle exec jekyll serve
42+
```
43+
1. Point your web browser to [http://localhost:4000](http://localhost:4000)
44+
1. Reload your web browser after making a change to preview its effect.
45+
46+
For more information, refer to [Just the Docs](https://pmarsceill.github.io/just-the-docs/).

‎_announcements/week-0.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: Week 0 Announcement
3+
week: 0
4+
date: 2019-04-01
5+
---
6+
7+
Hello world!
8+
{: .fs-5 }

‎_announcements/week-1.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: Week 1 Announcement
3+
week: 1
4+
date: 2019-04-08
5+
---
6+
7+
1. Create a [new repository based on Just the Class](https://github.com/kevinlin1/just-the-class/generate).
8+
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!
9+
1. Update `_config.yml` with your course information.
10+
1. Edit and create `.md` [Markdown files](https://guides.github.com/features/mastering-markdown/) to add your content.

‎_config.yml

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Welcome to Jekyll!
2+
#
3+
# This config file is meant for settings that affect your whole site, values
4+
# which you are expected to set up once and rarely edit after that. If you find
5+
# yourself editing these this file very often, consider using Jekyll's data files
6+
# feature for the data you need to update frequently.
7+
#
8+
# For technical reasons, this file is *NOT* reloaded automatically when you use
9+
# 'jekyll serve'. If you change this file, please restart the server process.
10+
11+
# Site settings
12+
# These are used to personalize your new site. If you look in the HTML files,
13+
# you will see them accessed via {{ site.title }}, {{ site.github_repo }}, and so on.
14+
# You can create any custom variable you would like, and they will be accessible
15+
# in the templates via {{ site.myvariable }}.
16+
title: Just the Class
17+
tagline: A Jekyll template for course websites
18+
description: A modern, highly customizable, responsive Jekyll template for course websites
19+
author: Kevin Lin
20+
baseurl: '/just-the-class' # the subpath of your site, e.g. /blog
21+
url: 'https://kevinl.info' # the base hostname & protocol for your site, e.g. http://example.com
22+
exclude: ["Gemfile", "Gemfile.lock", "LICENSE", "README.md"]
23+
24+
# Theme settings
25+
remote_theme: pmarsceill/[email protected]
26+
color_scheme: light
27+
search_enabled: true
28+
heading_anchors: true
29+
permalink: pretty
30+
aux_links:
31+
Kevin Lin:
32+
- 'https://kevinl.info'
33+
Just the Class on GitHub:
34+
- 'https://github.com/kevinlin1/just-the-class'
35+
footer_content:
36+
37+
# Collections for website data
38+
collections:
39+
staffers:
40+
modules:
41+
schedules:
42+
announcements:
43+
# Default layouts for each collection type
44+
defaults:
45+
- scope:
46+
path: ''
47+
type: staffers
48+
values:
49+
layout: staffer
50+
subpath: '/assets/images/'
51+
- scope:
52+
path: ''
53+
type: modules
54+
values:
55+
layout: module
56+
- scope:
57+
path: ''
58+
type: schedules
59+
values:
60+
layout: schedule
61+
- scope:
62+
path: ''
63+
type: announcements
64+
values:
65+
layout: announcement
66+
67+
compress_html:
68+
clippings: all
69+
comments: all
70+
endings: all
71+
startings: []
72+
blanklines: false
73+
profile: false
74+
75+
plugins:
76+
- jekyll-seo-tag

0 commit comments

Comments
 (0)