forked from kazemnejad/jekyll-course-website-template
-
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
7a8d270
commit 65ef1a6
Showing
2 changed files
with
7 additions
and
234 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,227 +0,0 @@ | ||
| # Features | ||
| - Individual page for assignments, lectures, course material, course schedule | ||
| - Auto generated Course schedule Page | ||
| - Auto generated course updates section (for each new lectures and assignments) + custom/manual announcements | ||
| - Super lightweight | ||
| - Highly customizable | ||
| - Ready to be used in Github Pages | ||
| - Responsive Mobile View | ||
| - Support for Google Analytics | ||
|
|
||
| # Change log | ||
| - Version 2.0 | ||
| - New Schedule page with more efficient use of space. | ||
| - Gregorian calendar is now the default one (English Calendar). | ||
| - Add customization options to home, assignments, lectures, and schedule pages. | ||
| - Add support for themes (so you can modify the website's look according to your school's brandings)!. | ||
| - Move navigation menus to YAML which means it is now easier to add new pages. | ||
| - Add more flexibility to lecture's links | ||
|
|
||
| # Demo | ||
| Checkout for a working demo at [kazemnejad.github.io/jekyll-course-website-template/](https://kazemnejad.github.io/jekyll-course-website-template/). You may also want to see this real-world example at [iust-deep-learning.github.io/972](https://iust-deep-learning.github.io/972/) or [iust-courses.github.io/ai97/](https://iust-courses.github.io/ai97/) (Please note the last two examples are using the older version). | ||
|
|
||
| # Some Screenshots | ||
| <p float="left"> | ||
| <img src="https://raw.githubusercontent.com/kazemnejad/jekyll-course-website-template/master/_images/screenshots/screen_home.jpg" width="300"> | ||
| <img src="https://raw.githubusercontent.com/kazemnejad/jekyll-course-website-template/master/_images/screenshots/screen_schedule.jpg" width="300"> | ||
| <img src="https://raw.githubusercontent.com/kazemnejad/jekyll-course-website-template/master/_images/screenshots/screen_lecture.jpg" width="300"> | ||
| </p> | ||
|
|
||
| <p float="left"> | ||
| <img src="https://raw.githubusercontent.com/kazemnejad/jekyll-course-website-template/master/_images/screenshots/screen_assign.jpg" width="300"> | ||
| <img src="https://raw.githubusercontent.com/kazemnejad/jekyll-course-website-template/master/_images/screenshots/screen_sample_assign.jpg" width="300"> | ||
| <img src="https://raw.githubusercontent.com/kazemnejad/jekyll-course-website-template/master/_images/screenshots/screen_material.jpg" width="300"> | ||
| </p> | ||
|
|
||
| # Acknowledgement | ||
| This template is heavily based on [svmiller / course-website](https://github.com/svmiller/course-website). | ||
|
|
||
| # How to deploy your own website (on GitHub pages) | ||
| 1. Fork this repository. | ||
| 2. Open `_config.yml`. | ||
| 1. Update `url` field according to your GitHub account (e.g., `https://<your-github-username>.github.io/`). | ||
| 2. Update `baseurl` field according to your reporsitory's name (e.g., `/cs101`). | ||
| 3. Commit and push your changes. | ||
| 3. Go to your repository's settigns (`https://github.com/<your-github-username>/<your-repo-name>/settings`). | ||
| 4. On GitHub Pages section, choose source to be your master branch, and enable Github Pages. | ||
| 5. You are now ready to go! Start customizing your website. | ||
|
|
||
| Pro Tip: You don't need to clone your repo to update your website. Use GitHub web UI to update its source files, and GitHub will build and deploy your website automatically! | ||
|
|
||
| **Best Practice for managing repositories**: If you plan to use this template for university courses, and the course is offered for multiple semesters/quarters, I suggests you to create a GitHub account or an Organization for it. Then, create new repoository under that account/organization for each semester. | ||
| - Example: | ||
| - Course name: CS101 | ||
| - Semester: Fall 2020 | ||
| - School name: CMU | ||
| - => account/org name: `cmu-cs101` | ||
| - => repo name: `fa2020` | ||
| - => website address will be: `https://cmu-cs101.github.io/fa2020/` | ||
|
|
||
| # How to test your website locally | ||
| 1. Install Jekyll ([Installation guide](https://jekyllrb.com/docs/installation/)) | ||
| 2. Clone your repo | ||
| 3. Watch your website while editing: `bundle exec jekyll serve` | ||
|
|
||
| # How to customize | ||
| ## Changing the names | ||
| - Open `_config.yml` | ||
| - Update `course_name`, `course_semester`, and `course_description` (this will appear in the home page). | ||
| - Update `schoolname`, `schoolurl`, `twitter_username`, and `address` accordingly. | ||
| - (Optional) Enter your Google Analytics tracking ID in the `google_analytics` field (Remember to uncomment it). | ||
| - Add more content to your home page: Update `index.md` (it supports Markdown!) | ||
| - Update course staff info at `_data/people.yml` (You may need to upload the profile pics to `_images` folder. | ||
| - (Optional) Open `_data/previous_offering.yml` and update the data if needed. | ||
|
|
||
| ## Change the looks | ||
| - Open `_sass/_user_vars.scss` | ||
| - Select your favorite from the pre-defined themes (comment all other themes, and uncomment your desired one) | ||
| - Here are all themes: | ||
| <img src="https://raw.githubusercontent.com/kazemnejad/jekyll-course-website-template/master/_images/screenshots/themes.png"> | ||
|
|
||
| - You can also change the colors manually to match your branding | ||
| ## Contents | ||
| ### Lectures | ||
| To add a new lecture, create an empty file with `.md` postfix in `_lectures/` directory. fill it using below template: | ||
| ```markdown | ||
| --- | ||
| type: lecture | ||
| date: 20xx-xx-xxTx:xx:xx+4:30 | ||
| title: <Title of this lecture> | ||
|
|
||
| # optional | ||
| # please use /static_files/notes directory to store notes | ||
| thumbnail: /static_files/path/to/image.jpg | ||
|
|
||
| # optional | ||
| tldr: "What is AI? How does it impact our lives? The current state of the art." | ||
|
|
||
| # optional | ||
| # set it to true if you dont want this lecture to appear in the updates section | ||
| hide_from_announcments: false | ||
|
|
||
| # optional | ||
| links: | ||
| - url: /static_files/presentations/lec.zip | ||
| name: notes | ||
| - url: /static_files/presentations/code.zip | ||
| name: codes | ||
| - url: https://google.com | ||
| name: slides | ||
| - url: https://example.com | ||
| name: other | ||
| --- | ||
| <!-- Other additional contents using markdown --> | ||
| **Suggested Readings:** | ||
| - [Readings 1](http://example.com) | ||
| - [Readings 2](http://example.com) | ||
| ``` | ||
|
|
||
| ### Assignments | ||
| To add a new assignments, create an empty file with `.md` postfix in `_assignments/` directory. fill it using below template: | ||
| ```markdown | ||
| --- | ||
| type: assignment | ||
| date: 20xx-xx-xxTx:xx:xx+4:30 | ||
| title: <Assignment title (e.g. Assignment #1> | ||
|
|
||
| # optional | ||
| pdf: /static_files/assignments/assign_01.pdf | ||
|
|
||
| # optional | ||
| solutions: /static_files/assignments/assign_01_solutions.pdf | ||
|
|
||
| # optional | ||
| attachment: /static_files/assignments/assign_01_attachment.zip | ||
|
|
||
| # optional | ||
| # set it to true if you don't want this assignment to appear in the announcements section | ||
| hide_from_announcments: false | ||
|
|
||
| due_event: | ||
| type: due | ||
| date: 20xx-xx-xxTx:xx:xx+4:30 | ||
| description: 'Assignment #1 due' | ||
| --- | ||
| <!-- Other additional contents using markdown --> | ||
| ``` | ||
|
|
||
| ### Dues & Deadlines | ||
| Use `_events/` directory to add new a deadline, use `type: due`. These events will apear at the schedule page. | ||
| ```markdown | ||
| --- | ||
| type: due | ||
| date: 20xx-xx-xxTx:xx:xx+4:30 | ||
| description: <Description of deadline (e.g. 'Final report due')> | ||
|
|
||
| # optional | ||
| # set it to true if you don't want this event to appear in the announcements section | ||
| hide_from_announcments: false | ||
| --- | ||
| ``` | ||
|
|
||
| ### Exams | ||
| Use `_events/` directory to add new Exam alert, use `type: exam`. These events will apear at the schedule page. | ||
| ```markdown | ||
| --- | ||
| type: exam | ||
| date: 20xx-xx-xxTx:xx:xx+4:30 | ||
| description: <Description of the exam (e.g. 'The midterm exam')> | ||
|
|
||
| # optional | ||
| # set it to true if you don't want to this event appear in the announcements section | ||
| hide_from_announcments: false | ||
| --- | ||
| ``` | ||
|
|
||
| ### Custom Events | ||
| Use `_events/` directory to add new custom events, use `type: raw_event`. These events will apear at the schedule page. | ||
| ```markdown | ||
| --- | ||
| type: raw_event | ||
| name: <Event name> | ||
| date: 20xx-xx-xxTx:xx:xx+4:30 | ||
| description: <Event description> | ||
|
|
||
| # optional | ||
| # if you want to hide time in Schedule, set this to true | ||
| hide_time: false | ||
|
|
||
| # optional | ||
| # set it to true if you don't want this event appear to in the announcements section | ||
| hide_from_announcments: false | ||
| --- | ||
| <!-- you can create custom content using markdown. this section will be placed in "Course Materials (in schedule section)" --> | ||
| ## Hello | ||
| this is a custom event with `code` | ||
| ``` | ||
|
|
||
|
|
||
| ### Updates/Announcements | ||
| All contents here appear in at the home page | ||
| Use `_announcements/` directory to create new Announcement | ||
| ```markdown | ||
| --- | ||
| date: 20xx-xx-xxTx:xx:xx+4:30 | ||
| --- | ||
| <put a short announcement here, you can use all markdown features> | ||
| ``` | ||
|
|
||
| ## Advanced Customization | ||
| You can add custom contents to each section (lectures, assignments, schedule, materials, and project) | ||
| - Lectures: Edit `lectures.md` | ||
| - Assignments: Edit `assignments.md` | ||
| - Schedule: Edit `schedule.md` | ||
| - Materials: Edit `materials.md` | ||
| - Project: Edit `project.md` | ||
|
|
||
| Additionally, you can update navigation menus (the menu at the top of the website) by editing `_data/nav.yml` | ||
|
|
||
| To add new section, add new navigation menu. Then create a new file in website's root directory using the following template: | ||
| ```markdown | ||
| --- | ||
| layout: page | ||
| title: Page Title | ||
| permalink: /page-address/ | ||
| --- | ||
| ``` | ||
|
|
||
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