forked from krrish94/sniffle-workshop
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Krishna Murthy <[email protected]>
- Loading branch information
0 parents
commit f370f61
Showing
67 changed files
with
2,281 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,5 @@ | ||
_site | ||
.sass-cache | ||
.jekyll-cache | ||
.jekyll-metadata | ||
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,25 @@ | ||
--- | ||
permalink: /404.html | ||
layout: default | ||
--- | ||
|
||
<style type="text/css" media="screen"> | ||
.container { | ||
margin: 10px auto; | ||
max-width: 600px; | ||
text-align: center; | ||
} | ||
h1 { | ||
margin: 30px 0; | ||
font-size: 4em; | ||
line-height: 1; | ||
letter-spacing: -1px; | ||
} | ||
</style> | ||
|
||
<div class="container"> | ||
<h1>404</h1> | ||
|
||
<p><strong>Page not found :(</strong></p> | ||
<p>The requested page could not be found.</p> | ||
</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,34 @@ | ||
source "https://rubygems.org" | ||
# Hello! This is where you manage which Jekyll version is used to run. | ||
# When you want to use a different version, change it below, save the | ||
# file and run `bundle install`. Run Jekyll with `bundle exec`, like so: | ||
# | ||
# bundle exec jekyll serve | ||
# | ||
# This will help ensure the proper Jekyll version is running. | ||
# Happy Jekylling! | ||
gem "jekyll", "~> 4.2.0" | ||
# This is the default theme for new Jekyll sites. You may change this to anything you like. | ||
# gem "minima", "~> 2.5" | ||
# If you want to use GitHub Pages, remove the "gem "jekyll"" above and | ||
# uncomment the line below. To upgrade, run `bundle update github-pages`. | ||
# gem "github-pages", group: :jekyll_plugins | ||
# If you have any plugins, put them here! | ||
group :jekyll_plugins do | ||
gem "jekyll-feed", "~> 0.12" | ||
end | ||
|
||
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem | ||
# and associated library. | ||
platforms :mingw, :x64_mingw, :mswin, :jruby do | ||
gem "tzinfo", "~> 1.2" | ||
gem "tzinfo-data" | ||
end | ||
|
||
# Performance-booster for watching directories on Windows | ||
gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin] | ||
|
||
|
||
gemspec | ||
|
||
gem "jekyll", ENV["JEKYLL_VERSION"] if ENV["JEKYLL_VERSION"] |
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,86 @@ | ||
PATH | ||
remote: . | ||
specs: | ||
minima (2.5.0) | ||
jekyll (>= 3.5, < 5.0) | ||
jekyll-feed (~> 0.9) | ||
jekyll-seo-tag (~> 2.1) | ||
|
||
GEM | ||
remote: https://rubygems.org/ | ||
specs: | ||
addressable (2.7.0) | ||
public_suffix (>= 2.0.2, < 5.0) | ||
colorator (1.1.0) | ||
concurrent-ruby (1.1.7) | ||
em-websocket (0.5.2) | ||
eventmachine (>= 0.12.9) | ||
http_parser.rb (~> 0.6.0) | ||
eventmachine (1.2.7) | ||
ffi (1.14.2) | ||
forwardable-extended (2.6.0) | ||
http_parser.rb (0.6.0) | ||
i18n (1.8.6) | ||
concurrent-ruby (~> 1.0) | ||
jekyll (4.2.0) | ||
addressable (~> 2.4) | ||
colorator (~> 1.0) | ||
em-websocket (~> 0.5) | ||
i18n (~> 1.0) | ||
jekyll-sass-converter (~> 2.0) | ||
jekyll-watch (~> 2.0) | ||
kramdown (~> 2.3) | ||
kramdown-parser-gfm (~> 1.0) | ||
liquid (~> 4.0) | ||
mercenary (~> 0.4.0) | ||
pathutil (~> 0.9) | ||
rouge (~> 3.0) | ||
safe_yaml (~> 1.0) | ||
terminal-table (~> 2.0) | ||
jekyll-feed (0.15.1) | ||
jekyll (>= 3.7, < 5.0) | ||
jekyll-sass-converter (2.1.0) | ||
sassc (> 2.0.1, < 3.0) | ||
jekyll-seo-tag (2.7.1) | ||
jekyll (>= 3.8, < 5.0) | ||
jekyll-watch (2.2.1) | ||
listen (~> 3.0) | ||
kramdown (2.3.0) | ||
rexml | ||
kramdown-parser-gfm (1.1.0) | ||
kramdown (~> 2.0) | ||
liquid (4.0.3) | ||
listen (3.4.0) | ||
rb-fsevent (~> 0.10, >= 0.10.3) | ||
rb-inotify (~> 0.9, >= 0.9.10) | ||
mercenary (0.4.0) | ||
pathutil (0.16.2) | ||
forwardable-extended (~> 2.6) | ||
public_suffix (4.0.6) | ||
rb-fsevent (0.10.4) | ||
rb-inotify (0.10.1) | ||
ffi (~> 1.0) | ||
rexml (3.2.4) | ||
rouge (3.26.0) | ||
safe_yaml (1.0.5) | ||
sassc (2.4.0) | ||
ffi (~> 1.9) | ||
terminal-table (2.0.0) | ||
unicode-display_width (~> 1.1, >= 1.1.1) | ||
unicode-display_width (1.7.0) | ||
|
||
PLATFORMS | ||
ruby | ||
x86_64-linux | ||
|
||
DEPENDENCIES | ||
bundler | ||
jekyll (~> 4.2.0) | ||
jekyll-feed (~> 0.12) | ||
minima! | ||
tzinfo (~> 1.2) | ||
tzinfo-data | ||
wdm (~> 0.1.1) | ||
|
||
BUNDLED WITH | ||
2.2.4 |
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,27 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2021-present Krishna Murthy Jatavallabhula | ||
|
||
Based on the jekyll minima theme. License reproduced below. | ||
|
||
=========================================================== | ||
|
||
Copyright (c) 2016-present Parker Moore and the minima contributors | ||
|
||
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,69 @@ | ||
# sniffle-workshop | ||
|
||
`sniffle` is an easy-to-use [Jekyll](https://jekyllrb.com/) theme, developed primarily for hosting workshop webpages in the AI / ML communities. `sniffle` automates many of the mundane tasks needed for workshop webpages, including: | ||
|
||
* curating **speaker** lists | ||
* curating **organizer** lists | ||
* populating **schedule** webpages | ||
* managing a list of **accepted papers** | ||
|
||
`sniffle` came about because of a [lazy grad student](https://krrish94.github.io)'s need to avoid the agonizing pain that went into populating the [DiffCVGP](https://montrealrobotics.ca/diffcvgp) and [Rethinking ML Papers](https://rethinkingmlpapers.github.io) workshop webpages. `sniffle` is based on Jekyll's default (and first) `minima` theme. | ||
|
||
|
||
**Here's a [preview webpage](https://krrish94.github.io/sniffle-workshop) for the theme.** | ||
|
||
Here's sample screenshots of various pages! | ||
|
||
![sniffle-workshop theme preview](assets/img/screenshot-home.png) ![sniffle-workshop theme preview](assets/img/screenshot-papers.png) ![sniffle-workshop theme preview](assets/img/screenshot-schedule.png) ![sniffle-workshop theme preview](assets/img/screenshot-speakers.png) | ||
|
||
## Installing Jekyll | ||
|
||
For more about how to use Jekyll, check out [these installation instructions](https://jekyllrb.com/docs/installation/). | ||
Why Jekyll? Read this [blog post](https://karpathy.github.io/2014/07/01/switching-to-jekyll/)! | ||
|
||
|
||
## Installation | ||
|
||
Assuming you have [Ruby](https://www.ruby-lang.org/en/downloads/) and [Bundler](https://bundler.io/) installed on your system (*hint: for ease of managing ruby gems, consider using [rbenv](https://github.com/rbenv/rbenv)*), first [fork](https://guides.github.com/activities/forking/) the theme from `github.com:krrish94/sniffle-workshop` to `github.com:<your-username>/<your-repo-name>` and do the following: | ||
|
||
```bash | ||
$ git clone [email protected]:<your-username>/<your-repo-name>.git | ||
$ cd <your-repo-name> | ||
$ bundle install | ||
$ bundle exec jekyll serve | ||
``` | ||
|
||
Now, feel free to customize the theme to your liking! | ||
|
||
|
||
## Using the theme | ||
|
||
The theme is quite easy to use if you're familiar with Jekyll. The following collections are implemented: | ||
1. **Speakers**: Curate a [speaker list like this one](speakers) from a set of markdown files, one per speaker. Crops and displays images if available. Adds a short bio. See files in the `_speakers` directory for examples. | ||
2. **Organizers**: Curate an organizer list from a set of markdown files, one per organizer. See files in the `_organizers` directory for examples. | ||
3. **Schedule**: Curate a [schedule like this](schedule) from a set of markdown files, one per event (talk, panel, break, etc.). See files in the `_schedule` directory for examples. Schedule items are sorted by a `sequence_id` attribute. | ||
4. **Papers**: Curate a [list of papers like this](papers) from a bunch of markdown files, one per paper. See files in the `_papers` directory for examples. Papers are sorted by a `sequence_id` attribute if specifed (else they are listed alphabetically). | ||
|
||
> **NOTE:** The best way to use these is to turn feature on or off by editing the `collections` attribute in `_config.yml`. | ||
If you experience issues or have cool features to add, feel free to [fork this template](). | ||
|
||
|
||
### Adding a speaker | ||
|
||
To add a speaker, simply create a copy of `_speakers/janedoe.md`, rename it, and edit the attributes of the speaker. Please read the comments in the markdown file; they describe the function of each attribute. | ||
|
||
|
||
### Adding an organizer | ||
|
||
To add an organizer, simply create a copy of `_organizers/organizerjanedoe.md`, rename it, and edit the attributes of the organizer. Please read the comments in the markdown file; they describe the function of each attribute. | ||
|
||
|
||
### Adding an event to your schedule | ||
|
||
To add an event to the workshop schedule, simply create a copy of `_schedule/talk_00_opening.md`, rename it, and edit the attributes of the event. Please read the comments in the markdown file; they describe the function of each attribute. | ||
|
||
|
||
### Adding a paper to the workshop's proceedings | ||
|
||
To add a paper to the workshop's proceedings, simply create a copy of `_schedule/paper_00.md`, rename it and edit the attributes of the paper. Please read the comments in the markdown file; they describe the function of each attribute. |
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,96 @@ | ||
# Welcome to Jekyll! | ||
# | ||
# This config file is meant for settings that affect your whole blog, values | ||
# which you are expected to set up once and rarely edit after that. If you find | ||
# yourself editing 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 | ||
# 'bundle exec jekyll serve'. If you change this file, please restart the server process. | ||
# | ||
# If you need help with YAML syntax, here are some quick references for you: | ||
# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml | ||
# https://learnxinyminutes.com/docs/yaml/ | ||
# | ||
# 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.email }}, and so on. | ||
# You can create any custom variable you would like, and they will be accessible | ||
# in the templates via {{ site.myvariable }}. | ||
|
||
title: Sniffle Workshop | ||
email: [email protected] | ||
description: >- # this means to ignore newlines until "baseurl:" | ||
Write an awesome description for the workshop site here. You can edit this | ||
line in _config.yml. It will appear in your document head meta (for | ||
Google search results) and in your feed.xml site description. | ||
baseurl: "" # the subpath of your site, e.g. /blog | ||
url: "" # the base hostname & protocol for your site, e.g. http://example.com | ||
twitter_username: rethinkmlpapers | ||
github_username: rethinkmlpapers | ||
|
||
# Build settings | ||
plugins: | ||
- jekyll-feed | ||
- jekyll-seo-tag | ||
|
||
# If you want to link only specific pages in your header, uncomment | ||
# this and add the path to the pages in order as they should show up | ||
header_pages: | ||
- index.md | ||
- speakers.md | ||
- organizers.md | ||
- callforpapers.md | ||
- schedule.md | ||
- papers.md | ||
- contactus.md | ||
|
||
# # Specify the name of a file to show as a masthead graphic at the top of each page, instead of a title, here: | ||
# masthead: assets/img/banner.jpg | ||
# # Description (alt text) for the masthead | ||
# masthead_description: Adapted from Machine Learning & Artificial Intelligence by mikemacmarketing; licensed under CC BY 2.0 | ||
|
||
# A two-line attribution (remove this if you have to, but we'd appreciate if you leave this as is) | ||
attribution: > | ||
Based on a <a href="http://jekyllrb.com/" target="_blank">Jekyll</a> template from a <a href="https://krrish94.github.io">lazy grad student</a>. | ||
Some icons made by <a href="https://smashicons.com/" title="Smashicons">Smashicons</a> from <a href="https://www.flaticon.com/" title="Flaticon">www.flaticon.com</a>. | ||
# Displays a "last updated" date in the footer if set to "true" | ||
last_updated: true | ||
|
||
# Define collections (speakers, organizers, papers) | ||
# To turn off any of these collections, just set "output" to "false" | ||
collections: | ||
speakers: | ||
output: true | ||
organizers: | ||
output: true | ||
schedule: | ||
sort_by: sequence_id | ||
output: true | ||
papers: | ||
sort_by: sequence_id | ||
output: true | ||
|
||
# Exclude from processing. | ||
# The following items will not be processed, by default. | ||
# Any item listed under the `exclude:` key here will be automatically added to | ||
# the internal "default list". | ||
# | ||
# Excluded items can be processed by explicitly listing the directories or | ||
# their entries' file path in the `include:` list. | ||
# | ||
# exclude: | ||
# - .sass-cache/ | ||
# - .jekyll-cache/ | ||
# - gemfiles/ | ||
# - Gemfile | ||
# - Gemfile.lock | ||
# - node_modules/ | ||
# - vendor/bundle/ | ||
# - vendor/cache/ | ||
# - vendor/gems/ | ||
# - vendor/ruby/ | ||
|
||
# Google analytics id. Add your tracking id to get visitor stats. | ||
# google_analytics: # tracking id |
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,6 @@ | ||
{% comment %} | ||
Placeholder to allow defining custom head, in principle, you can add anything here, e.g. favicons: | ||
|
||
1. Head over to https://realfavicongenerator.net/ to add your own favicons. | ||
2. Customize default _includes/custom-head.html in your source directory and insert the given code snippet. | ||
{% endcomment %} |
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 @@ | ||
{%- if page.comments != false and jekyll.environment == "production" -%} | ||
|
||
<div id="disqus_thread"></div> | ||
<script> | ||
var disqus_config = function () { | ||
this.page.url = '{{ page.url | absolute_url }}'; | ||
this.page.identifier = '{{ page.url | absolute_url }}'; | ||
}; | ||
|
||
(function() { | ||
var d = document, s = d.createElement('script'); | ||
|
||
s.src = 'https://{{ site.disqus.shortname }}.disqus.com/embed.js'; | ||
|
||
s.setAttribute('data-timestamp', +new Date()); | ||
(d.head || d.body).appendChild(s); | ||
})(); | ||
</script> | ||
<noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript" rel="nofollow">comments powered by Disqus.</a></noscript> | ||
{%- endif -%} |
Oops, something went wrong.