Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
amirhosein committed Feb 13, 2019
0 parents commit 94cca1c
Show file tree
Hide file tree
Showing 53 changed files with 2,252 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.sass-cache
_site
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2017 Steven V. Miller

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.
135 changes: 135 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
Development strategy
=======================================================

# How to build & contribute
1. clone repository `git clone https://github.com/iust-courses/iust-courses.github.io.git`
2. `cd iust-courses.github.io/developments/ai97`
3. install requirements:
`gem install jekyll-jalali`
4. add your content, apply your changes.
4. build! `jekyll build -d ../../ai97/`
5. push your changes

# How to edit website
There are 6 types of content you can add to the website, each content category has its own template & its own subdirectory. if you use just use with these categories then All pages will be generated automatically for you including Announcements, Schedule, and Lectures.

## Lectures
If you want to add a new lecture, please 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
suggested_readings:
- title: Readings 1
url: http://example.com # optional attribute
- title: Readings 2
url: http://example2.com # optional attribute

# optional
# please use /static_files/presentations directory to store slides
slides: /static_files/presentations/1-Introduction-Fa.pdf

# optional
# please use /static_files/notes directory to store notes
notes: /static_files/notes/notes_01.pdf

# 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 to this lecture appear in the announcements section
hide_from_announcments: false
---
```

## Announcements
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>
```

## Assignments
Use `_assignments/` directory to create new Assignment
```markdown
---
type: assignment
date: 20xx-xx-xxTx:xx:xx+4:30
title: <Assignment title (e.x. Assignment #1>

# optinal
pdf: /static_files/assignments/assign_01.pdf

# optinal
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 to this assignment appear in the announcements section
hide_from_announcments: false
---
```

## Dues & Deadlines
Use `_events/` directory to add new Deadline, use `type: due`
```markdown
---
type: due
date: 20xx-xx-xxTx:xx:xx+4:30
description: <Description of deadline (e.x. 'Assignment #1 due')>

# optional
# set it to true if you don't want to this event appear in the announcements section
hide_from_announcments: false
---
```

## Exams
Use `_events/` directory to add new Exam alert, use `type: exam`
```markdown
---
type: exam
date: 20xx-xx-xxTx:xx:xx+4:30
description: <Description of the exam (e.x. '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 Exam alert, use `type: exam`
```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 to this event appear 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`
```
### Acknowledgement
This template is heavily based on [svmiller / course-website](https://github.com/svmiller/course-website) works.

4 changes: 4 additions & 0 deletions _announcements/01_sample_announcement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
date: 2018-10-03T10:00:00+3:30
---
Sample announcement, Please check out [here](/).
10 changes: 10 additions & 0 deletions _assignments/01_sample_assignment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
type: assignment
date: 2018-09-26T4:00:00+4:30
title: 'Assignment #1 - Sample Assignment'
pdf: /static_files/assignments/asg.pdf
attachment: /static_files/assignments/asg.zip
solutions: /static_files/assignments/asg_solutions.pdf
due: 2018-11-13T23:59:00+3:30
---
This is a sample assignment.
57 changes: 57 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# Site settings
title: Iran University of Science and Technology
course_name: Course Name
course_description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam ornare aliquam mattis. Donec hendrerit sollicitudin urna. Aliquam venenatis rutrum velit, at lobortis dui cursus a. Nam varius metus in turpis maximus, ut rhoncus tellus dictum. In aliquam tortor nec mi dapibus, sit amet vehicula dolor auctor."
course_semester: "Fall 2050"
description: |
Instructor: Alan Turing
message: Register to our Google <a href="https://groups.google.com/forum/#!forum/gp-id">groups page</a> to get course notifications via email.
baseurl: "/base-url" # the subpath of your site, e.g. /blog/
url: "http://iust-courses.github.io/" # the base hostname & protocol for your site
githubdir: "username/repo"

# Author/user information
email: [email protected]
twitter_username: username
github_username: username
authorurl: "http://author-url.com/page"
address: |
School of Computer Engineering
Iran University of Science and Technology
Tehran, Iran
# Build settings
markdown: kramdown

# Other options
permalink: blog/:year/:month/:title
excerpt_separator: "<!--more-->"

include: ['_images', '_css']
exclude: ['develop']

future: true
collections:
events:
output: true
lectures:
output: true
assignments:
output: true
announcements:
output: false


defaults:
- scope:
path: ""
type: "assignments"
values:
layout: "assignment"



plugins:
- jekyll-jalali
61 changes: 61 additions & 0 deletions _css/main.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
# Only the main Sass file needs front matter (the dashes are enough)
---
@charset "utf-8";



// Our variables
$base-font-family: 'Open Sans', Helvetica, Arial, sans-serif;
$base-font-size: .95em;
$small-font-size: $base-font-size * 0.875;
$base-line-height: 1.5;

$spacing-unit: 30px;

$text-color: #111;
$background-color: #fdfdfd;
$brand-color: #0077CC;
// $gameday-sky: #109dc0;
$clemson-purple: #336699;
$clemson-orange: #f66733;


$grey-color: #828282;
$grey-color-light: lighten($grey-color, 40%);
$grey-color-dark: darken($grey-color, 25%);


// Width of the content area
$content-width: 950px;

$on-palm: 600px;
$on-laptop: 950px;



// Using media queries with like this:
// @include media-query($on-palm) {
// .wrapper {
// padding-right: $spacing-unit / 2;
// padding-left: $spacing-unit / 2;
// }
// }
@mixin media-query($device) {
@media screen and (max-width: $device) {
@content;
}
}



// Import partials from `sass_dir` (defaults to `_sass`)
@import
"header",
"mobile-header",
"base",
"layout",
"syntax-highlighting",
"fancy-image"
;

4 changes: 4 additions & 0 deletions _data/late_policy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
policies:
- You have free 8 late days.
- You can use late days for assignments. A late day extends the deadline 24 hours.
- Once you have used all 8 late days, the penalty is 10% for each additional late day.
10 changes: 10 additions & 0 deletions _data/people.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
instructor:
name: Alan Turing
profile_pic: /_images/pp/inst.jpg

teaching_assistants:
- name: Nikola tesla
profile_pic: /_images/pp/ta01.jpg

- name: Albert Einstein
profile_pic: /_images/pp/ta02.jpg
6 changes: 6 additions & 0 deletions _data/previous_offering.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
offerings:
- title: Fall 2049
url: https://previous_course_website.url/

- title: Fall 2048
url: https://previous_course_website.url/
6 changes: 6 additions & 0 deletions _events/sample_due.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
type: due
date: 2018-10-23T23:59:59+3:30
description: 'Assignment #1 due'
hide_from_announcments: true
---
10 changes: 10 additions & 0 deletions _events/sample_exam_due.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
type: exam
date: 2018-12-02T8:0:0+3:30
description: 'Midterm'
hide_from_announcments: true
---
**Topics:**
<br> - Topic 1
<br> - Topic 2
<br> - Topic 3
7 changes: 7 additions & 0 deletions _events/sample_raw_event.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
type: raw_event
date: 2019-01-26T08:00:00+3:30
name: Session
description: 'Sample Raw Event'
hide_from_announcments: true
---
Binary file added _images/cover2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/iust.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/pp/inst.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/pp/ta01.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/pp/ta02.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
33 changes: 33 additions & 0 deletions _includes/announcements.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
{% assign all_events = site.events | concat: site.lectures %}
{% assign all_events = all_events | concat: site.assignments %}

{% assign events_to_show = "" | split: "" %}
{% for e in all_events %}
{% unless e.hide_from_announcments %}
{% assign events_to_show = events_to_show | push: e %}
{% endunless %}
{% endfor %}

{% assign all_events = events_to_show | concat: site.announcements %}
{% assign all_events_sorted = all_events | sort: 'date' | reverse %}

<ul>
{% for n in all_events_sorted limit:7 %}
<li class="no-p-margin">
{% if n.type %}
{% if n.type == 'lecture' %}
New Lecture is up: {{ n.title }}
{% if n.slides %}
[<a href="{{ n.slides | prepend: site.baseurl }}">slides</a>]
{% endif %}
{% elsif n.type == 'assignment' %}
New Assignment released: [<a href="{{ n.url | prepend: site.baseurl }}">{{ n.title }}</a>]
{% else%}
{{ n.description }}
{% endif %}
{% else %}
{{ n.content }}
{% endif %}
</li>
{% endfor %}
</ul>
Binary file added _includes/cover2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions _includes/embedpdf.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<iframe src="//docs.google.com/viewer?url=https://dl.dropboxusercontent.com/s/{{ include.code}}?dl=0&hl=en_US&embedded=true" class="gde-frame" style="width:{{include.width}}%; height:{{include.height}}px; border: none;" scrolling="no"></iframe>
Loading

0 comments on commit 94cca1c

Please sign in to comment.