generated from acm-uiuc/sig-website-template
-
Notifications
You must be signed in to change notification settings - Fork 2
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
0 parents
commit 9a4a9b0
Showing
34 changed files
with
992 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,38 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Describe the bug** | ||
A clear and concise description of what the bug is. | ||
|
||
**To Reproduce** | ||
Steps to reproduce the behavior: | ||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
**Screenshots** | ||
If applicable, add screenshots to help explain your problem. | ||
|
||
**Desktop (please complete the following information):** | ||
- OS: [e.g. iOS] | ||
- Browser [e.g. chrome, safari] | ||
- Version [e.g. 22] | ||
|
||
**Smartphone (please complete the following information):** | ||
- Device: [e.g. iPhone6] | ||
- OS: [e.g. iOS8.1] | ||
- Browser [e.g. stock browser, safari] | ||
- Version [e.g. 22] | ||
|
||
**Additional context** | ||
Add any other context about the problem here. |
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 |
---|---|---|
@@ -0,0 +1,5 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: Ask a question | ||
url: https://github.com/kevinlin1/just-the-class/discussions | ||
about: Ask questions and discuss with other community members |
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 |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
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 |
---|---|---|
@@ -0,0 +1,64 @@ | ||
# This workflow uses actions that are not certified by GitHub. | ||
# They are provided by a third-party and are governed by | ||
# separate terms of service, privacy policy, and support | ||
# documentation. | ||
|
||
# Sample workflow for building and deploying a Jekyll site to GitHub Pages | ||
name: Deploy Jekyll site to Pages | ||
|
||
on: | ||
# Runs on pushes targeting the default branch | ||
push: | ||
branches: ["main"] | ||
|
||
# Allows you to run this workflow manually from the Actions tab | ||
workflow_dispatch: | ||
|
||
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | ||
permissions: | ||
contents: read | ||
pages: write | ||
id-token: write | ||
|
||
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | ||
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | ||
concurrency: | ||
group: "pages" | ||
cancel-in-progress: false | ||
|
||
jobs: | ||
# Build job | ||
build: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
- name: Setup Ruby | ||
uses: ruby/setup-ruby@8575951200e472d5f2d95c625da0c7bec8217c42 # v1.161.0 | ||
with: | ||
ruby-version: '3.1' # Not needed with a .ruby-version file | ||
bundler-cache: true # runs 'bundle install' and caches installed gems automatically | ||
cache-version: 0 # Increment this number if you need to re-download cached gems | ||
- name: Setup Pages | ||
id: pages | ||
uses: actions/configure-pages@v5 | ||
- name: Build with Jekyll | ||
# Outputs to the './_site' directory by default | ||
run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}" | ||
env: | ||
JEKYLL_ENV: production | ||
- name: Upload artifact | ||
# Automatically uploads an artifact from the './_site' directory by default | ||
uses: actions/upload-pages-artifact@v3 | ||
|
||
# Deployment job | ||
deploy: | ||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
runs-on: ubuntu-latest | ||
needs: build | ||
steps: | ||
- name: Deploy to GitHub Pages | ||
id: deployment | ||
uses: actions/deploy-pages@v4 |
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 |
---|---|---|
@@ -0,0 +1,9 @@ | ||
*.gem | ||
.bundle/ | ||
.jekyll-cache/ | ||
.jekyll-metadata | ||
.sass-cache/ | ||
Gemfile.lock | ||
_site/ | ||
node_modules/ | ||
vendor/ |
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 |
---|---|---|
@@ -0,0 +1,3 @@ | ||
source 'https://rubygems.org' | ||
gem 'github-pages', group: :jekyll_plugins | ||
gem "webrick", "~> 1.8" |
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 |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2019 Kevin Lin | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
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 |
---|---|---|
@@ -0,0 +1,55 @@ | ||
--- | ||
layout: home | ||
title: Home | ||
nav_exclude: true | ||
permalink: /:path/ | ||
seo: | ||
type: Course | ||
name: {{ site.title }} | ||
--- | ||
|
||
# {{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 [calendar](calendar.md), | ||
- a [staff](staff.md) page, | ||
- and a weekly [schedule](schedule.md). | ||
|
||
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 the ACM SIG template is simple. | ||
|
||
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. | ||
|
||
### 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/) |
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 |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
title: Week 0 Announcement | ||
week: 0 | ||
date: 2024-08-28 | ||
--- | ||
|
||
Hello world! | ||
{: .fs-5 } |
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 |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
title: Week 1 Announcement | ||
week: 1 | ||
date: 2024-09-08 | ||
--- | ||
|
||
1. Meet | ||
2. Profit?? |
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 |
---|---|---|
@@ -0,0 +1,84 @@ | ||
# Welcome to Jekyll! | ||
# | ||
# This config file is meant for settings that affect your whole site, values | ||
# which you are expected to set up once and rarely edit after that. If you find | ||
# yourself editing these this file very often, consider using Jekyll's data files | ||
# feature for the data you need to update frequently. | ||
# | ||
# For technical reasons, this file is *NOT* reloaded automatically when you use | ||
# 'jekyll serve'. If you change this file, please restart the server process. | ||
|
||
# Site settings | ||
# These are used to personalize your new site. If you look in the HTML files, | ||
# 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: 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: acm-uiuc/[email protected] | ||
color_scheme: light | ||
search_enabled: true | ||
heading_anchors: true | ||
permalink: pretty | ||
aux_links: | ||
"GitHub": | ||
- 'https://github.com' | ||
footer_content: | ||
nav_external_links: | ||
- title: Calendar | ||
url: https://acm.illinois.edu/calendar | ||
|
||
# Collections for website data | ||
collections: | ||
staffers: | ||
modules: | ||
schedules: | ||
announcements: | ||
# Default layouts for each collection type | ||
defaults: | ||
- scope: | ||
path: '' | ||
type: staffers | ||
values: | ||
layout: staffer | ||
height: 300 | ||
subpath: '/assets/images/' | ||
width: 300 | ||
- scope: | ||
path: '' | ||
type: modules | ||
values: | ||
layout: module | ||
- scope: | ||
path: '' | ||
type: schedules | ||
values: | ||
layout: schedule | ||
- scope: | ||
path: '' | ||
type: announcements | ||
values: | ||
layout: announcement | ||
|
||
compress_html: | ||
clippings: all | ||
comments: all | ||
endings: all | ||
startings: [] | ||
blanklines: false | ||
profile: false | ||
|
||
liquid: | ||
error_mode: strict | ||
strict_filters: true | ||
|
||
plugins: | ||
- jekyll-include-cache |
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 |
---|---|---|
@@ -0,0 +1,20 @@ | ||
{% capture _minutes_workspace %} | ||
{% comment %} | ||
Return the number of minutes between midnight and the given time string (e.g. '9:30 AM'). | ||
Parameters: | ||
`time` (string): the time to convert. | ||
{% endcomment %} | ||
|
||
{% assign _time = include.time %} | ||
{% assign _hhmm = _time | split: ' ' | first | split: ':' %} | ||
{% assign _hours = _hhmm | first | to_integer %} | ||
{% assign _minutes = _hhmm | last | to_integer %} | ||
{% assign _ampm = _time | split: ' ' | last | upcase %} | ||
|
||
{% if _ampm == 'AM' and _hours == 12 %} | ||
{% assign _hours = _hours | minus: 12 %} | ||
{% elsif _ampm == 'PM' and _hours != 12 %} | ||
{% assign _hours = _hours | plus: 12 %} | ||
{% endif %} | ||
{% endcapture %}{% assign _minutes_workspace = '' %}{{ _hours | times: 60 | plus: _minutes }} |
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 |
---|---|---|
@@ -0,0 +1,14 @@ | ||
<div class="announcement"> | ||
<h2>{{ page.title }}</h2> | ||
<span class="announcement-meta"> | ||
{% if page.date %} | ||
{{ page.date | date: '%b %e' }} | ||
· | ||
{% endif %} | ||
{% assign minutes = content | strip_html | number_of_words | divided_by: 180.0 | round %} | ||
{{ minutes }} min read | ||
</span> | ||
<div> | ||
{{ content }} | ||
</div> | ||
</div> |
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 |
---|---|---|
@@ -0,0 +1,4 @@ | ||
<h2 class="fs-4" id="{{ page.title | slugify }}" >{{ page.title }}</h2> | ||
<div class="module"> | ||
{{ content }} | ||
</div> |
Oops, something went wrong.