Skip to content

Commit ae8b607

Browse files
committed
sig template stuff
1 parent c074283 commit ae8b607

20 files changed

+104
-101
lines changed

Gemfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
source 'https://rubygems.org'
22
gem 'github-pages', group: :jekyll_plugins
3-
gem "webrick", "~> 1.8"
3+
gem "webrick", "~> 1.8"

README.md

Lines changed: 29 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,55 @@
11
---
22
layout: home
3-
title: Just the Class
3+
title: Home
44
nav_exclude: true
55
permalink: /:path/
66
seo:
77
type: Course
8-
name: Just the Class
8+
name: {{ site.title }}
99
---
1010

11-
# Just the Class
12-
13-
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:
11+
# {{site.title}}
12+
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:
1413

1514
- [announcements](announcements.md),
16-
- a [course calendar](calendar.md),
15+
- a [calendar](calendar.md),
1716
- a [staff](staff.md) page,
1817
- and a weekly [schedule](schedule.md).
1918

20-
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:
19+
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:
2120

2221
- automatic [navigation structure](https://just-the-docs.github.io/just-the-docs/docs/navigation-structure/),
2322
- instant, full-text [search](https://just-the-docs.github.io/just-the-docs/docs/search/) and page indexing,
2423
- 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).
2524

25+
# Recent Announcements
26+
27+
{% assign announcements = site.announcements | reverse %}
28+
{% assign announcement_count = announcements | size %}
29+
30+
<div class="announcements-list">
31+
{% for announcement in announcements limit:5 %}
32+
{{ announcement }}
33+
{% endfor %}
34+
</div>
35+
36+
{% if announcement_count > 5 %}
37+
<a href="/announcements" class="see-all-link">See All Announcements</a>
38+
{% endif %}
39+
2640
## Getting Started
2741

28-
Getting started with Just the Class is simple.
42+
Getting started with the ACM SIG template is simple.
2943

30-
1. Create a [new repository based on Just the Class](https://github.com/kevinlin1/just-the-class/generate).
31-
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/).
32-
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!
44+
1. Create a [new repository based on the template](https://github.com/acm-uiuc/sig-website-template/generate).
45+
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/).
46+
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!
3347
1. Edit and create `.md` [Markdown files](https://guides.github.com/features/mastering-markdown/) to add more content pages.
3448

35-
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)!
36-
3749
### Local development environment
3850

3951
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).
52+
53+
## Attribution
54+
* [Just The Class](https://kevinl.info/just-the-class/)
55+
* [Just The Docs](https://just-the-docs.com/)

_announcements/week-0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Week 0 Announcement
33
week: 0
4-
date: 2019-04-01
4+
date: 2024-08-28
55
---
66

77
Hello world!

_announcements/week-1.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
---
22
title: Week 1 Announcement
33
week: 1
4-
date: 2019-04-08
4+
date: 2024-09-08
55
---
66

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.
7+
1. Meet
8+
2. Profit??

_config.yml

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,26 +13,28 @@
1313
# you will see them accessed via {{ site.title }}, {{ site.github_repo }}, and so on.
1414
# You can create any custom variable you would like, and they will be accessible
1515
# 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
16+
title: SIGExample
17+
tagline: A group focused on an area of computing.
18+
description: A modern, highly customizable, responsive Jekyll template for ACM SIG websites
19+
author: SIGExample
20+
baseurl: '' # the subpath of your site, e.g. /blog
21+
url: 'https://sigexample.acm.illinois.edu' # the base hostname & protocol for your site, e.g. http://example.com
2222
exclude: ["Gemfile", "Gemfile.lock", "LICENSE"]
23+
# logo: "/assets/images/acm-wordmark-light.png"
2324

2425
# Theme settings
25-
remote_theme: just-the-docs/just-the-docs@v0.10.0
26+
remote_theme: acm-uiuc/sig-website-jekyll-theme@v0.11.1
2627
color_scheme: light
2728
search_enabled: true
2829
heading_anchors: true
2930
permalink: pretty
3031
aux_links:
31-
Kevin Lin:
32-
- 'https://kevinl.info'
33-
Just the Class on GitHub:
34-
- 'https://github.com/kevinlin1/just-the-class'
32+
"GitHub":
33+
- 'https://github.com'
3534
footer_content:
35+
nav_external_links:
36+
- title: Calendar
37+
url: https://acm.illinois.edu/calendar
3638

3739
# Collections for website data
3840
collections:
@@ -77,3 +79,6 @@ compress_html:
7779
liquid:
7880
error_mode: strict
7981
strict_filters: true
82+
83+
plugins:
84+
- jekyll-include-cache

_modules/week-01.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Introduction to Java
2+
title: Introduction to SIGExample
33
---
44

55
Sep 28

_modules/week-02.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Basic Data Structures
2+
title: SIGExample Topic 1
33
---
44

55
Oct 5

_staffers/evil-kevin.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

_staffers/jdoe.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
name: John Doe
3+
role: Chair
4+
pronouns: he/him
5+
6+
website: https://cs.illinois.edu
7+
photo: kevin.jpg
8+
---
9+
10+
I am a chair.

_staffers/jdoe2.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
name: Jane Doe
3+
role: Chair
4+
pronouns: she/her
5+
6+
website: https://cs.illinois.edu
7+
photo: kevin.jpg
8+
---
9+
10+
I am yet another chair.

0 commit comments

Comments
 (0)