Skip to content

Commit

Permalink
sig template stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
devksingh4 committed Sep 29, 2024
1 parent c074283 commit ae8b607
Show file tree
Hide file tree
Showing 20 changed files with 104 additions and 101 deletions.
2 changes: 1 addition & 1 deletion Gemfile
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
source 'https://rubygems.org'
gem 'github-pages', group: :jekyll_plugins
gem "webrick", "~> 1.8"
gem "webrick", "~> 1.8"
42 changes: 29 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,55 @@
---
layout: home
title: Just the Class
title: Home
nav_exclude: true
permalink: /:path/
seo:
type: Course
name: Just the Class
name: {{ site.title }}
---

# 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:
# {{site.title}}
This repository is a GitHub Pages template developed for the purpose of quickly deploying SIG websites. In addition to serving plain web pages and files, it provides a boilerplate for:

- [announcements](announcements.md),
- a [course calendar](calendar.md),
- a [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:
This 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).

# Recent Announcements

{% assign announcements = site.announcements | reverse %}
{% assign announcement_count = announcements | size %}

<div class="announcements-list">
{% for announcement in announcements limit:5 %}
{{ announcement }}
{% endfor %}
</div>

{% if announcement_count > 5 %}
<a href="/announcements" class="see-all-link">See All Announcements</a>
{% endif %}

## Getting Started

Getting started with Just the Class is simple.
Getting started with the ACM SIG template 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. Create a [new repository based on the template](https://github.com/acm-uiuc/sig-website-template/generate).
1. Update `_config.yml` and `README.md` with your SIG 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 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

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).

## Attribution
* [Just The Class](https://kevinl.info/just-the-class/)
* [Just The Docs](https://just-the-docs.com/)
2 changes: 1 addition & 1 deletion _announcements/week-0.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Week 0 Announcement
week: 0
date: 2019-04-01
date: 2024-08-28
---

Hello world!
Expand Down
8 changes: 3 additions & 5 deletions _announcements/week-1.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
---
title: Week 1 Announcement
week: 1
date: 2019-04-08
date: 2024-09-08
---

1. Create a [new repository based on Just the Class](https://github.com/kevinlin1/just-the-class/generate).
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. Update `_config.yml` with your course information.
1. Edit and create `.md` [Markdown files](https://guides.github.com/features/mastering-markdown/) to add your content.
1. Meet
2. Profit??
27 changes: 16 additions & 11 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,26 +13,28 @@
# you will see them accessed via {{ site.title }}, {{ site.github_repo }}, and so on.
# You can create any custom variable you would like, and they will be accessible
# in the templates via {{ site.myvariable }}.
title: Just the Class
tagline: A Jekyll template for course websites
description: A modern, highly customizable, responsive Jekyll template for course websites
author: Kevin Lin
baseurl: '/just-the-class' # the subpath of your site, e.g. /blog
url: 'https://kevinl.info' # the base hostname & protocol for your site, e.g. http://example.com
title: SIGExample
tagline: A group focused on an area of computing.
description: A modern, highly customizable, responsive Jekyll template for ACM SIG websites
author: SIGExample
baseurl: '' # the subpath of your site, e.g. /blog
url: 'https://sigexample.acm.illinois.edu' # the base hostname & protocol for your site, e.g. http://example.com
exclude: ["Gemfile", "Gemfile.lock", "LICENSE"]
# logo: "/assets/images/acm-wordmark-light.png"

# Theme settings
remote_theme: just-the-docs/just-the-docs@v0.10.0
remote_theme: acm-uiuc/sig-website-jekyll-theme@v0.11.1
color_scheme: light
search_enabled: true
heading_anchors: true
permalink: pretty
aux_links:
Kevin Lin:
- 'https://kevinl.info'
Just the Class on GitHub:
- 'https://github.com/kevinlin1/just-the-class'
"GitHub":
- 'https://github.com'
footer_content:
nav_external_links:
- title: Calendar
url: https://acm.illinois.edu/calendar

# Collections for website data
collections:
Expand Down Expand Up @@ -77,3 +79,6 @@ compress_html:
liquid:
error_mode: strict
strict_filters: true

plugins:
- jekyll-include-cache
2 changes: 1 addition & 1 deletion _modules/week-01.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Introduction to Java
title: Introduction to SIGExample
---

Sep 28
Expand Down
2 changes: 1 addition & 1 deletion _modules/week-02.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Basic Data Structures
title: SIGExample Topic 1
---

Oct 5
Expand Down
9 changes: 0 additions & 9 deletions _staffers/evil-kevin.md

This file was deleted.

10 changes: 10 additions & 0 deletions _staffers/jdoe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: John Doe
role: Chair
pronouns: he/him
email: [email protected]
website: https://cs.illinois.edu
photo: kevin.jpg
---

I am a chair.
10 changes: 10 additions & 0 deletions _staffers/jdoe2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: Jane Doe
role: Chair
pronouns: she/her
email: [email protected]
website: https://cs.illinois.edu
photo: kevin.jpg
---

I am yet another chair.
11 changes: 0 additions & 11 deletions _staffers/kevin.md

This file was deleted.

11 changes: 11 additions & 0 deletions _staffers/lead1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
name: John Doe
role: Lead
meta: [['Infrastructure Lead']]
pronouns: he/him
email: [email protected]
website: https://cs.illinois.edu
photo: kevin.jpg
---

I am a lead.
9 changes: 0 additions & 9 deletions _staffers/more-evil-kevin.md

This file was deleted.

9 changes: 0 additions & 9 deletions _staffers/really-evil-kevin.md

This file was deleted.

2 changes: 1 addition & 1 deletion about.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: page
title: About
description: >-
Course policies and information.
SIGExample information.
---

# About
Expand Down
2 changes: 1 addition & 1 deletion announcements.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: Announcements
nav_exclude: true
nav_exclude: false
description: A feed containing all of the class announcements.
---

Expand Down
Binary file added assets/images/acm-wordmark-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 0 additions & 11 deletions calendar.md

This file was deleted.

12 changes: 7 additions & 5 deletions schedule.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
---
layout: page
title: Schedule
description: The weekly event schedule.
title: Meetings
description: Listing of SIG meetings and topics.
---

# Weekly Schedule
# Meetings

{% for schedule in site.schedules %}
{{ schedule }}
**Usually, we will meet in every Friday from 5-6pm in Siebel 2102.**

{% for module in site.modules %}
{{ module }}
{% endfor %}
24 changes: 12 additions & 12 deletions staff.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
---
layout: page
title: Staff
description: A listing of all the course staff members.
title: Our Team
description: A listing of all our leadership members.
---

# Staff
# Leadership

Staff information is stored in the `_staffers` directory and rendered according to the layout file, `_layouts/staffer.html`.
Leadership information is stored in the `_staffers` directory and rendered according to the layout file, `_layouts/staffer.html`.

## Instructors
## Chairs

{% assign instructors = site.staffers | where: 'role', 'Instructor' %}
{% for staffer in instructors %}
{% assign chairs = site.staffers | where: 'role', 'Chair' %}
{% for staffer in chairs %}
{{ staffer }}
{% endfor %}

{% assign teaching_assistants = site.staffers | where: 'role', 'Teaching Assistant' %}
{% assign num_teaching_assistants = teaching_assistants | size %}
{% if num_teaching_assistants != 0 %}
## Teaching Assistants
{% assign leads = site.staffers | where: 'role', 'Lead' %}
{% assign num_leads = leads | size %}
{% if num_leads != 0 %}
## Leads

{% for staffer in teaching_assistants %}
{% for staffer in leads %}
{{ staffer }}
{% endfor %}
{% endif %}

0 comments on commit ae8b607

Please sign in to comment.