Initial commit

.github/workflows/release.yml

@@ -0,0 +1,47 @@
+name: Deploy to Github Pages
+
+on:
+  push:
+    branches:
+      - master
+
+# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
+permissions:
+  contents: read
+  pages: write      # to deploy to Pages
+  id-token: write   # to verify the deployment originates from an appropriate source
+
+env:
+  JEKYLL_ENV: production
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+
+    - name: Build Jekyll for GitHub Pages
+      uses: actions/jekyll-build-pages@v1.0.7
+      with:
+          source: ./
+          destination: ./_site
+    - name: Upload artifact
+      uses: actions/upload-pages-artifact@v1
+
+  # Deploy job
+  deploy:
+    # Add a dependency to the build job
+    needs: build
+
+    # Deploy to the github-pages environment
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+    steps:
+    - name: Deploy GitHub Pages site
+      id: deployment
+      uses: actions/deploy-pages@v1.2.4
+

.gitignore

@@ -0,0 +1,4 @@
+_site
+.jekyll-metadata
+Gemfile.lock
+*.DS_Store

CREDITS.md

@@ -0,0 +1,3 @@
+# Credits
+
+* Original template structure: [https://github.com/yishanhe/jekyll-conference-template](https://github.com/yishanhe/jekyll-conference-template)

Gemfile

@@ -0,0 +1 @@
+Gemfile.github

Gemfile.github

@@ -0,0 +1,23 @@
+source "https://rubygems.org"
+ruby RUBY_VERSION
+
+# 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.3.1"
+
+# 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 "tzinfo-data"
+  gem "tzinfo"
+  gem "jekyll-minifier"
+end

Gemfile.local

@@ -0,0 +1,27 @@
+source "https://rubygems.org"
+ruby "2.6.6"
+
+# 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.3.1"
+
+# 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-admin"
+#end
+
+group :jekyll_plugins do
+  gem "tzinfo-data"
+  gem "tzinfo"
+  gem "jekyll-minifier"
+end

INSTALL.md

@@ -0,0 +1,38 @@
+# Install
+
+The template is powered by Jekyll and tuned to work with GitHub workflows.
+
+For local deployment, use `Gemfile.local`
+
+## Requirements
+
+* Ruby (`v2.6.6`)
+* Gems:
+  - Bundler
+  - Jekyll
+
+## Instructions
+
+* Install **rvm** (Ruby Version Manager) by following the instructions from https://rvm.io/
+  - `rvm use 2.6.6`
+* Install Jekyll
+  - `gem update --system`
+  - `gem install sass-embedded -v 1.57.1`
+  - `gem install bundler jekyll`
+* Repository setup
+  - Clone the repository
+  - Change directory to the clone location
+  - `make setup` OR `bundle install`
+* Configure
+  - Edit `_config.yml`
+  - Edit `_data/*.yml` for conference configuration
+  - Edit `index.md`
+  - Edit `history.md`
+* Test
+  - `make serve`
+* Build
+  - `make build`
+* Publish (Currently, copy the built directory to install location)
+  - Edit `Makefile` to set your install path
+  - `make publish`
+  - **NOTE**: You will need to manually commit the code for the website.

LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2023 Hrishikesh Terdalkar
+Copyright (c) 2016-2018 Shanhe Yi
+
+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.

Makefile

@@ -0,0 +1,13 @@
+INSTALL_PATH = "/home/hrishirt/git/iscls/iscls.github.io/docs/"
+
+setup:
+	bundle install
+
+serve:
+	bundle exec jekyll serve
+
+build:
+	export JEKYLL_ENV="production" && bundle exec jekyll build
+
+publish: build
+	rsync -avzc --delete _site/ ${INSTALL_PATH}

README.md

@@ -0,0 +1,61 @@
+# Jekyll-based Conference Template
+
+An academic conference website template built using Jekyll.
+
+## Configuration
+
+Data Files under `_data` to configure all conference related information.
+
+- `conference.yml`
+  - `full_title`: conference fullname e.g., First xxx conference on xxxx, 2017.
+  - `short_title`: conference shortname e.g., xxxx2017
+  - `description`: short description about the conference (< 160 char)
+  - `location`: conference location
+  - `logo_path`: conference logo
+  - `slideshow`: images slideshow
+  - `navbar`: navigation menu.
+  - `sponsors`: sponsor section.
+  - `deadlines`: important dates of deadlines, pass-due date will be automatically printed with del line.
+  - `social_media`: social media on the navbar. (current support facebook and twitter.)
+- `news.yml`: news section
+- `organization.yml`: committees
+  - `programm_chair`: program chair
+  - `organizing_committees`: organizing committees
+  - `steering_committees`: steering committees
+  - `technical_program_committees`: technical program committees
+- `venue.yml`: information about venue
+  - `address`: full address
+  - `accommodation`: accommodation details
+  - `direction`: path to image containing directions
+- `submission.yml`: submission instructions
+- `registration.yml`: registration information
+
+- Google Analytics: in `_config.yml`
+
+## Deployment
+
+### Manual
+
+* Setup Ruby, RVM, Jeykyll, Bundler.
+  - Check installation instructions at [INSTALL.md](INSTALL.md).
+* Remove `.github/workflows/`
+* Change target of the symbolic `Gemfile` to `Gemfile.local`
+  ```
+  rm Gemfile
+  ln -s Gemfile.local Gemfile
+  ```
+* Adjust release path in `Makefile`
+* Test locally, `make serve`
+* Build and copy to publish location, `make publish`
+* Commit changes to the publish location
+
+### GitHub Pages
+
+* Ensure that the repository is public and GitHub Pages are enabled and set to use GitHub Actions.
+* Create `.github/workflows`
+* Copy `workflows/release.yml` to `.github/workflows/release.yml`
+* Change target of the symbolic `Gemfile` to `Gemfile.github`
+  ```
+  rm Gemfile
+  ln -s Gemfile.github Gemfile
+  ```

TODO.md

@@ -0,0 +1,7 @@
+## TODO
+
+- [ ] add https://www.timeanddate.com/ link to deadlines.
+- [ ] seperate some layouts/includes into a theme
+- [ ] make the project extensible with different themes.
+- [ ] clean Jekyll pages, put html code into layout/includes, pure markdown in pages.
+- [ ] Makefile integration for docker run, ssh upload, rsync

_config.yml

@@ -0,0 +1,62 @@
+# 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.
+
+# 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 }}.
+
+baseurl: "" # the subpath of your site, e.g. /blog
+url: "https://iscls.github.io" # the base hostname & protocol for your site, e.g. http://example.com
+css: ./assets/main.css
+
+show_last_updated: True
+last_updated_format: '%B %d, %Y, %T.'
+
+# Plugin settings
+
+## Plugin: jekyll-minifier
+## https://github.com/digitalsparky/jekyll-minifier
+## NOTE: requires environment variable JEKYLL_ENV to be set to "production"
+jekyll-minifier:
+  remove_comments: true             # Default: true
+  remove_spaces_inside_tags: true   # Default: true
+  remove_multi_spaces: true         # Default: true
+  remove_intertag_spaces: true      # Default: false
+  preserve_line_breaks: true        # Default: false
+  compress_css: true                # Default: true
+  compress_javascript: true         # Default: true
+  compress_json: true               # Default: true
+  compress_js_templates: true       # Default: false
+
+# Build settings
+markdown: kramdown
+exclude:
+  - Gemfile
+  - Gemfile.lock
+  - Gemfile.local
+  - Gemfile.github
+  - Makefile
+  - README.md
+  - INSTALL.md
+  - TODO.md
+  - CREDITS.md
+  - LICENSE
+  - preview/
+  - workflows/
+  - .github/
+  - .gitignore
+
+timezone: India/Kolkata
+google_analytics: ""
+
+plugins:
+  - jekyll-minifier