diff --git a/.all-contributorsrc b/.all-contributorsrc
new file mode 100644
index 000000000000..cfa9c210cd12
--- /dev/null
+++ b/.all-contributorsrc
@@ -0,0 +1,55 @@
+{
+ "files": [
+ "README.md"
+ ],
+ "imageSize": 100,
+ "commit": false,
+ "contributorsPerLine": 7,
+ "projectName": "al-folio",
+ "projectOwner": "alshedivat",
+ "repoType": "github",
+ "repoHost": "https://github.com",
+ "badgeTemplate": "[core_contributors]: https://img.shields.io/badge/core_contributors-<%= contributors.length %>-orange.svg 'Number of core contributors'",
+ "contributorTemplate": "\">\" width=\"<%= options.imageSize %>px;\" alt=\"\"/> <%= contributor.name %>",
+ "skipCi": true,
+ "contributors": [
+ {
+ "login": "alshedivat",
+ "name": "Maruan",
+ "avatar_url": "https://avatars.githubusercontent.com/u/2126561?v=4",
+ "profile": "http://maruan.alshedivat.com",
+ "contributions": [
+ "design",
+ "code"
+ ]
+ },
+ {
+ "login": "rohandebsarkar",
+ "name": "Rohan Deb Sarkar",
+ "avatar_url": "https://avatars.githubusercontent.com/u/50144004?v=4",
+ "profile": "http://rohandebsarkar.github.io",
+ "contributions": [
+ "code"
+ ]
+ },
+ {
+ "login": "pourmand1376",
+ "name": "Amir Pourmand",
+ "avatar_url": "https://avatars.githubusercontent.com/u/32064808?v=4",
+ "profile": "https://amirpourmand.ir",
+ "contributions": [
+ "code"
+ ]
+ },
+ {
+ "login": "george-gca",
+ "name": "George",
+ "avatar_url": "https://avatars.githubusercontent.com/u/31376482?v=4",
+ "profile": "https://george-gca.github.io/",
+ "contributions": [
+ "code"
+ ]
+ }
+ ],
+ "commitConvention": "angular"
+}
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
deleted file mode 100644
index c78502f480c8..000000000000
--- a/.github/FUNDING.yml
+++ /dev/null
@@ -1,12 +0,0 @@
-# These are supported funding model platforms
-
-github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
-patreon: # Replace with a single Patreon username
-open_collective: # Replace with a single Open Collective username
-ko_fi: alshedivat
-tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
-community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
-liberapay: # Replace with a single Liberapay username
-issuehunt: # Replace with a single IssueHunt username
-otechie: # Replace with a single Otechie username
-custom: # ['https://www.buymeacoffee.com/TkFxuKo']
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 1cc44f62d15e..511f585150ba 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -10,7 +10,7 @@ assignees: ''
**Acknowledge the following**
- [ ] I carefully read and followed the [Getting Started](https://github.com/alshedivat/al-folio#getting-started) guide.
- [ ] I read through [FAQ](https://github.com/alshedivat/al-folio#faq) and searched through the [past issues](https://github.com/alshedivat/al-folio/issues), none of which addressed my issue.
-- [ ] The issue I am raising is a potential bug in al-folio and not just a usage question. [For usage questions, please use [gitter chat](https://gitter.im/alshedivat/al-folio) instead of raising an issue.]
+- [ ] The issue I am raising is a potential bug in al-folio and not just a usage question. [For usage questions, please post in the [Discussions](https://github.com/alshedivat/al-folio/discussions) instead of raising an issue.]
**Describe the bug**
A clear and concise description of what the bug is.
diff --git a/.github/workflows/deploy-docker-tag.yml b/.github/workflows/deploy-docker-tag.yml
new file mode 100644
index 000000000000..e101aa4b4e47
--- /dev/null
+++ b/.github/workflows/deploy-docker-tag.yml
@@ -0,0 +1,40 @@
+name: Docker Image CI (Upload Tag)
+
+on:
+ push:
+ tags:
+ - 'v*'
+
+jobs:
+
+ build:
+
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v3
+ - name: Buildx
+ uses: docker/setup-buildx-action@v1
+
+ -
+ name: Docker meta
+ id: meta
+ uses: docker/metadata-action@v4
+ with:
+ images: amirpourmand/al-folio
+
+ - name: Login
+ uses: docker/login-action@v1
+ with:
+ username: ${{ secrets.DOCKER_USERNAME }}
+ password: ${{ secrets.DOCKER_PASSWORD }}
+
+ - name: Build and push
+ uses: docker/build-push-action@v3
+ with:
+ context: .
+ push: ${{ github.event_name != 'pull_request' }}
+ tags: ${{ steps.meta.outputs.tags }}
+ labels: ${{ steps.meta.outputs.labels }}
+
diff --git a/.github/workflows/deploy-image.yml b/.github/workflows/deploy-image.yml
new file mode 100644
index 000000000000..883ac2d8f8b7
--- /dev/null
+++ b/.github/workflows/deploy-image.yml
@@ -0,0 +1,31 @@
+name: Docker Image CI
+
+on:
+ push:
+ branches: [ master ]
+
+jobs:
+
+ build:
+
+ runs-on: ubuntu-latest
+ if: github.repository_owner == 'alshedivat'
+
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v3
+ - name: Buildx
+ uses: docker/setup-buildx-action@v1
+
+ - name: Login
+ uses: docker/login-action@v1
+ with:
+ username: ${{ secrets.DOCKER_USERNAME }}
+ password: ${{ secrets.DOCKER_PASSWORD }}
+
+ - name: Build and push
+ uses: docker/build-push-action@v2
+ with:
+ context: .
+ push: true
+ tags: amirpourmand/al-folio
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
index 2d986f11eedb..5d2be6f71258 100644
--- a/.github/workflows/deploy.yml
+++ b/.github/workflows/deploy.yml
@@ -1,48 +1,37 @@
-name: Deploy
+name: deploy
on:
push:
branches:
- master
+ - main
pull_request:
branches:
- master
+ - main
+ workflow_dispatch:
+
+permissions:
+ contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- - name: Checkout code
- uses: actions/checkout@v2
+ - name: Checkout 🛎️
+ uses: actions/checkout@v3
- name: Setup Ruby
- uses: actions/setup-ruby@v1
- with:
- ruby-version: '2.7'
- - name: Enable bundler cache
- uses: actions/cache@v2
+ uses: ruby/setup-ruby@v1
with:
- path: vendor/bundle
- key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
- restore-keys: |
- ${{ runner.os }}-gems-
- - name: Install deps
- run: |
- gem install bundler
- bundle config path vendor/bundle
- bundle install --jobs 4 --retry 3
- - name: Setup deploy options
- id: setup
+ ruby-version: '3.2.1'
+ bundler-cache: true
+ - name: Install and Build 🔧
run: |
- git config --global user.name "GitHub Action"
- git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
- if [[ ${GITHUB_REF} = refs/pull/*/merge ]]; then # pull request
- echo "::set-output name=SRC_BRANCH::${GITHUB_HEAD_REF}"
- echo "::set-output name=NO_PUSH::--no-push"
- elif [[ ${GITHUB_REF} = refs/heads/* ]]; then # branch, e.g. master, source etc
- echo "::set-output name=SRC_BRANCH::${GITHUB_REF#refs/heads/}"
- fi
- echo "::set-output name=DEPLOY_BRANCH::gh-pages"
- - name: Deploy website
- run: yes | bin/deploy --verbose ${{ steps.setup.outputs.NO_PUSH }}
- --src ${{ steps.setup.outputs.SRC_BRANCH }}
- --deploy ${{ steps.setup.outputs.DEPLOY_BRANCH }}
+ npm install -g mermaid.cli
+ bundle exec jekyll build
+ - name: Deploy 🚀
+ if: github.event_name != 'pull_request'
+ uses: JamesIves/github-pages-deploy-action@v4
+ with:
+ folder: _site
+
diff --git a/.gitignore b/.gitignore
index 154f43588f89..b97cf91da550 100644
--- a/.gitignore
+++ b/.gitignore
@@ -8,3 +8,4 @@ _site
.tweet-cache
Gemfile.lock
vendor
+
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
new file mode 100644
index 000000000000..ca7e46543084
--- /dev/null
+++ b/.pre-commit-config.yaml
@@ -0,0 +1,10 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+ rev: v4.3.0
+ hooks:
+ - id: trailing-whitespace
+ - id: end-of-file-fixer
+ - id: check-yaml
+ - id: check-added-large-files
diff --git a/.travis.yml b/.travis.yml
deleted file mode 100644
index 328023abbe33..000000000000
--- a/.travis.yml
+++ /dev/null
@@ -1,19 +0,0 @@
-language: ruby
-rvm:
- - 2.4.1
-
-# Assume bundler is being used, therefore
-# the `install` step will run `bundle install` by default.
-script: ./bin/cibuild
-
-env:
- global:
- - NOKOGIRI_USE_SYSTEM_LIBRARIES=true # speeds up installation of html-proofer
-
-sudo: false # route your build to the container-based infrastructure for a faster build
-
-cache: bundler # caching bundler gem packages will speed up build
-
-# Optional: disable email notifications about the outcome of your builds
-notifications:
- email: false
diff --git a/404.html b/404.html
new file mode 100644
index 000000000000..2b454cad7248
--- /dev/null
+++ b/404.html
@@ -0,0 +1,9 @@
+---
+layout: page
+permalink: /404.html
+title: "Page not found"
+description: "Looks like there has been a mistake. Nothing exists here."
+redirect: true
+---
+
+
You will be redirected to the main page within 3 seconds. If not redirected, please go back to the home page.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index fd4d94318e2a..349456bf9032 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -15,7 +15,7 @@ Before submitting an issue, please make sure:
1. You have read [the FAQ section](https://github.com/alshedivat/al-folio#faq) of the README and your question is NOT addressed there.
2. You have done your best to ensure that your issue is NOT a duplicate of one of [the previous issues](https://github.com/alshedivat/al-folio/issues).
3. Your issue is either a bug (unexpected/undesirable behavior) or a feature request.
-If it is just a question, please ask it on [gitter](https://gitter.im/alshedivat/al-folio).
+If it is just a question, please ask it in the [Discussions](https://github.com/alshedivat/al-folio/discussions) forum.
When submitting an issue, please make sure to use the appropriate template.
diff --git a/Dockerfile b/Dockerfile
new file mode 100644
index 000000000000..a1eb21a9f908
--- /dev/null
+++ b/Dockerfile
@@ -0,0 +1,24 @@
+FROM bitnami/minideb:latest
+Label MAINTAINER Amir Pourmand
+RUN apt-get update -y
+# add locale
+RUN apt-get -y install locales
+# Set the locale
+RUN sed -i '/en_US.UTF-8/s/^# //g' /etc/locale.gen && \
+ locale-gen
+ENV LANG en_US.UTF-8
+ENV LANGUAGE en_US:en
+ENV LC_ALL en_US.UTF-8
+
+# add ruby and jekyll
+RUN apt-get install --no-install-recommends ruby-full build-essential zlib1g-dev -y
+RUN apt-get install imagemagick -y
+RUN apt-get clean \
+ && rm -rf /var/lib/apt/lists/
+# ENV GEM_HOME='root/gems' \
+# PATH="root/gems/bin:${PATH}"
+RUN gem install jekyll bundler
+RUN mkdir /srv/jekyll
+ADD Gemfile /srv/jekyll
+WORKDIR /srv/jekyll
+RUN bundle install
\ No newline at end of file
diff --git a/Gemfile b/Gemfile
index d87f96d290e5..b0cf11d34238 100644
--- a/Gemfile
+++ b/Gemfile
@@ -1,14 +1,24 @@
source 'https://rubygems.org'
group :jekyll_plugins do
+ gem 'classifier-reborn'
gem 'jekyll'
+ gem 'jekyll-archives'
+ gem 'jekyll-diagrams'
gem 'jekyll-email-protect'
gem 'jekyll-feed'
- gem 'jekyll-github-metadata'
+ gem 'jekyll-imagemagick'
+ gem 'jekyll-link-attributes'
+ gem 'jekyll-minifier'
gem 'jekyll-paginate-v2'
gem 'jekyll-scholar'
- gem 'jekyll-twitter-plugin'
gem 'jekyll-sitemap'
+ gem 'jekyll-twitter-plugin'
gem 'jemoji'
+ gem 'mini_racer'
gem 'unicode_utils'
gem 'webrick'
end
+group :other_plugins do
+ gem 'feedjira'
+ gem 'httparty'
+end
diff --git a/LICENSE b/LICENSE
index 33652759bb02..f2b868157f9b 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,6 +1,6 @@
The MIT License (MIT)
-Copyright (c) 2020 Maruan Al-Shedivat.
+Copyright (c) 2022 Maruan Al-Shedivat.
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
diff --git a/README.md b/README.md
index 8871557aba3d..9dd8ef1f36ef 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,26 @@
# al-folio
+
+[maintainers]: https://img.shields.io/badge/maintainers-4-success.svg 'Number of maintainers'
+
-[](https://travis-ci.org/alshedivat/al-folio)
+[](https://github.com/alshedivat/al-folio/actions/workflows/deploy.yml)
[](https://alshedivat.github.io/al-folio/)
[](https://github.com/alshedivat/al-folio/graphs/contributors/)
-
-
+[![Maintainers][maintainers]](#maintainers)
+[](https://github.com/alshedivat/al-folio/releases/latest)
+[](https://github.com/alshedivat/al-folio/blob/master/LICENSE)
[](https://github.com/alshedivat/al-folio)
[](https://github.com/alshedivat/al-folio/fork)
-[](https://ko-fi.com/alshedivat)
+
+[](https://hub.docker.com/r/amirpourmand/al-folio)
+[](https://hub.docker.com/r/amirpourmand/al-folio)
+[](https://hub.docker.com/r/amirpourmand/al-folio)
A simple, clean, and responsive [Jekyll](https://jekyllrb.com/) theme for academics.
If you like the theme, give it a star!
[](https://alshedivat.github.io/al-folio/)
-
## User community
The vibrant community of **al-folio** users is growing!
@@ -26,13 +32,13 @@ Feel free to add your own page(s) by sending a PR.
Academics
-★
+★★★
-★
+★★★
-★
+★★★★
@@ -55,7 +61,38 @@ Feel free to add your own page(s) by sending a PR.
★★★
-
+★
+★
+★
+★
+★
+★
+★
+★
+★
+★
+★
+★
+★
+★
+★
+★
+★
+★
+★
+★
+★
+★
+★
+★
+★
+★
+★
+★
+★
+★
+★
+★
@@ -66,105 +103,198 @@ Feel free to add your own page(s) by sending a PR.
★★★
+★
+★
+ICLR Blog Post Track (2023)
ML Retrospectives (NeurIPS: 2019, 2020; ICML: 2020)
HAMLETS (NeurIPS: 2020)
-ICBINB (NeurIPS: 2020)
-Neural Compression (ICLR: 2021)
+ICBINB (NeurIPS: 2020, 2021)
+Neural Compression (ICLR: 2021)
+Score Based Methods (NeurIPS: 2022)
+Images2Symbols (CogSci: 2022)
+## Lighthouse PageSpeed Insights
+
+[](https://pagespeed.web.dev/report?url=https%3A%2F%2Fsummer-heart-0930.chufeiyun1688.workers.dev%3A443%2Fhttps%2Falshedivat.github.io%2Fal-folio%2F&form_factor=desktop)
+
+## Table Of Contents
+
+ * [User community](#user-community)
+ * [Lighthouse PageSpeed Insights](#lighthouse-pagespeed-insights)
+ * [Getting started](#getting-started)
+ + [Installation](#installation)
+ - [Local setup using Docker (Recommended on Windows)](#local-setup-using-docker-recommended-on-windows)
+ - [Local Setup (Standard)](#local-setup-standard)
+ - [Deployment](#deployment)
+ - [Upgrading from a previous version](#upgrading-from-a-previous-version)
+ + [FAQ](#faq)
+ * [Features](#features)
+ + [Publications](#publications)
+ + [Collections](#collections)
+ + [Layouts](#layouts)
+ - [The iconic style of Distill](#the-iconic-style-of-distill)
+ - [Full support for math & code](#full-support-for-math--code)
+ - [Photos](#photos)
+ + [Other features](#other-features)
+ - [GitHub repositories and user stats](#github-repositories-and-user-stats)
+ - [Theming](#theming)
+ - [Social media previews](#social-media-previews)
+ - [Atom (RSS-like) Feed](#atom-rss-like-feed)
+ - [Related posts](#related-posts)
+ * [Contributing](#contributing)
+ + [Core Contributors](#core-contributors)
+ * [License](#license)
## Getting started
-For more about how to use Jekyll, check out [this tutorial](https://www.taniarascia.com/make-a-static-website-with-jekyll/).
+Want to learn more about Jekyll? Check out [this tutorial](https://www.taniarascia.com/make-a-static-website-with-jekyll/).
Why Jekyll? Read [Andrej Karpathy's blog post](https://karpathy.github.io/2014/07/01/switching-to-jekyll/)!
-
### Installation
-#### Local setup
+For a hands-on walkthrough of al-folio installation, check out [this cool video tutorial](https://www.youtube.com/watch?v=g6AJ9qPPoyc) by one of the community members! 🎬 🍿
-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:alshedivat/al-folio` to `github.com:/` and do the following:
+The preferred way of using this template is by clicking in [Use this template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template#creating-a-repository-from-a-template) above the file list.
+Then, create a new repository at `github.com:/`. If you plan to upload your site to `.github.io`,
+note that the name of your repository must be `.github.io` or `.github.io`, as stated in the [GitHub pages docs](https://docs.github.com/en/pages/getting-started-with-github-pages/about-github-pages#types-of-github-pages-sites).
+For more information on how to deploy your site, check the [Deployment](#deployment) section below. After you created your new repository, just download it to your machine:
```bash
$ git clone git@github.com:/.git
$ cd
+```
+
+---
+
+#### Local setup using Docker (Recommended on Windows)
+
+You need to take the following steps to get `al-folio` up and running in your local machine:
+
+- First, install [docker](https://docs.docker.com/get-docker/) and [docker-compose](https://docs.docker.com/compose/install/).
+- Finally, run the following command that will pull a pre-built image from DockerHub and will run your website.
+
+```bash
+$ docker-compose up
+```
+
+Note that when you run it for the first time, it will download a docker image of size 300MB or so.
+
+Now, feel free to customize the theme however you like (don't forget to change the name!). After you are done, you can use the same command (`docker-compose up`) to render the webpage with all you changes. Also, make sure to commit your final changes.
+
+> To change port number, you can edit `docker-compose.yml` file.
+
+(click to expand) Build your own docker image:
+
+> Note: this approach is only necessary if you would like to build an older or very custom version of al-folio.
+
+Build and run a new docker image using:
+
+```bash
+$ docker-compose -f docker-local.yml up
+```
+
+> If you want to update jekyll, install new ruby packages, etc., all you have to do is build the image again using `--force-recreate` argument at the end of previous command! It will download ruby and jekyll and install all ruby packages again from scratch.
+
+
+
+---
+
+#### Local Setup (Standard)
+
+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)*).
+
+```bash
$ bundle install
-$ bundle exec jekyll serve
+$ bundle exec jekyll serve --lsi
```
Now, feel free to customize the theme however you like (don't forget to change the name!).
After you are done, **commit** your final changes.
+---
+
#### Deployment
Deploying your website to [GitHub Pages](https://pages.github.com/) is the most popular option.
Starting version [v0.3.5](https://github.com/alshedivat/al-folio/releases/tag/v0.3.5), **al-folio** will automatically re-deploy your webpage each time you push new changes to your repository! :sparkles:
-**For project pages (default):**
+**For personal and organization webpages:**
-- Make changes, commit, and push!
-- After deployment, the webpage will become available at `.github.io//`.
-- The `master` branch should be used for the source code of your webpage and `gh-pages` branch (will be created on the first deployment) will be used for deployment.
+1. The name of your repository **MUST BE** `.github.io` or `.github.io`.
+2. In `_config.yml`, set `url` to `https://.github.io` and leave `baseurl` empty.
+3. Set up automatic deployment of your webpage (see instructions below).
+4. Make changes, commit, and push!
+5. After deployment, the webpage will become available at `.github.io`.
-**For personal and organization webpages:**
-- Rename your repository to `.github.io` or `.github.io`.
-- Click on **Actions** tab and **Enable GitHub Actions**; you no need to worry about creating any workflows as everything has already been set for you.
-- Make sure the `url` and `baseurl` fields in `_config.yml` are empty.
-- Make any other changes to your webpage, commit, and push. This will automatically trigger the **Deploy** action.
-- Wait for a few minutes and let the action complete. You can see the progress in the **Actions** tab. If completed successfully, in addition to the `master` branch, your repository should now have a newly built `gh-pages` branch.
-- Finally, in the **Settings**, in the Pages section, set the branch to `gh-pages` (**NOT** to `master`). See [Configuring a publishing source for your GitHub Pages site](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#choosing-a-publishing-source) for more details.
+**For project pages:**
-Manual deployment to GitHub Pages:
+1. In `_config.yml`, set `url` to `https://.github.io` and `baseurl` to `//`.
+2. Set up automatic deployment of your webpage (see instructions below).
+3. Make changes, commit, and push!
+4. After deployment, the webpage will become available at `.github.io//`.
+
+**To enable automatic deployment:**
+
+1. Click on **Actions** tab and **Enable GitHub Actions**; do not worry about creating any workflows as everything has already been set for you.
+2. Go to Settings -> Actions -> General -> Workflow permissions, and give **Read and write permissions** to GitHub Actions
+3. Make any other changes to your webpage, commit, and push. This will automatically trigger the **Deploy** action.
+4. Wait for a few minutes and let the action complete. You can see the progress in the **Actions** tab. If completed successfully, in addition to the `master` branch, your repository should now have a newly built `gh-pages` branch.
+5. Finally, in the **Settings** of your repository, in the Pages section, set the branch to `gh-pages` (**NOT** to `master`). For more details, see [Configuring a publishing source for your GitHub Pages site](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#choosing-a-publishing-source).
-If you need to manually re-deploy your website to GitHub pages, run the deploy script from the root directory of your repository:
-```bash
-$ ./bin/deploy
-```
-uses the `master` branch for the source code and deploys the webpage to `gh-pages`.
+
+(click to expand) Manual deployment to GitHub Pages:
+
+If you need to manually re-deploy your website to GitHub pages, go to Actions, click "Deploy" in the left sidebar, then "Run workflow."
-Deployment to another hosting server (non GitHub Pages):
+(click to expand) Deployment to another hosting server (non GitHub Pages):
If you decide to not use GitHub Pages and host your page elsewhere, simply run:
+
```bash
-$ bundle exec jekyll build
+$ bundle exec jekyll build --lsi
```
+
which will (re-)generate the static webpage in the `_site/` folder.
-Then simply copy the contents of the `_site/` foder to your hosting server.
+Then simply copy the contents of the `_site/` directory to your hosting server.
-**Note:** Make sure to correctly set the `url` and `baseurl` fields in `_config.yml` before building the webpage. If you are deploying your webpage to `your-domain.com/your-project/`, you must set `url: your-domain.com` and `baseurl: /your-project/`. If you are deploing directly to `your-domain.com`, leave `baseurl` blank.
+**Note:** Make sure to correctly set the `url` and `baseurl` fields in `_config.yml` before building the webpage. If you are deploying your webpage to `your-domain.com/your-project/`, you must set `url: your-domain.com` and `baseurl: /your-project/`. If you are deploying directly to `your-domain.com`, leave `baseurl` blank.
-Deployment to a separate repository (advanced users only):
+(click to expand) Deployment to a separate repository (advanced users only):
**Note:** Do not try using this method unless you know what you are doing (make sure you are familiar with [publishing sources](https://help.github.com/en/github/working-with-github-pages/about-github-pages#publishing-sources-for-github-pages-sites)). This approach allows to have the website's source code in one repository and the deployment version in a different repository.
-Let's assume that your website's publishing source is a `publishing-source` sub-directory of a git-versioned repository cloned under `$HOME/repo/`.
+Let's assume that your website's publishing source is a `publishing-source` subdirectory of a git-versioned repository cloned under `$HOME/repo/`.
For a user site this could well be something like `$HOME/.github.io`.
Firstly, from the deployment repo dir, checkout the git branch hosting your publishing source.
Then from the website sources dir (commonly your al-folio fork's clone):
+
```bash
-$ bundle exec jekyll build --destination $HOME/repo/publishing-source
+$ bundle exec jekyll build --lsi --destination $HOME/repo/publishing-source
```
This will instruct jekyll to deploy the website under `$HOME/repo/publishing-source`.
@@ -180,34 +310,65 @@ The quote below is taken directly from the [jekyll configuration docs](https://j
> Do not use an important location for ``; instead, use it as a staging area and copy files from there to your web server.
If `$HOME/repo/publishing-source` contains files that you want jekyll to leave untouched, specify them under `keep_files` in `_config.yml`.
-In its default configuration, al-folio will copy the top-level `README.md` to the publishing source. If you want to change this behaviour, add `README.md` under `exclude` in `_config.yml`.
+In its default configuration, al-folio will copy the top-level `README.md` to the publishing source. If you want to change this behavior, add `README.md` under `exclude` in `_config.yml`.
**Note:** Do _not_ run `jekyll clean` on your publishing source repo as this will result in the entire directory getting deleted, irrespective of the content of `keep_files` in `_config.yml`.
+---
+
#### Upgrading from a previous version
-If you installed **al-folio** as described above, you can upgrade to the latest version as follows:
+If you installed **al-folio** as described above, you can configure a [GitHub action](https://github.com/AndreasAugustin/actions-template-sync) to automatically sync your repository with the latest version of the theme:
+
+```yaml
+name: Sync from template
+on:
+ # cronjob trigger
+ schedule:
+ - cron: "0 0 1 * *"
+ # manual trigger
+ workflow_dispatch:
+jobs:
+ repo-sync:
+ runs-on: ubuntu-latest
+ steps:
+ # To use this repository's private action, you must check out the repository
+ - name: Checkout
+ uses: actions/checkout@v3
+ - name: actions-template-sync
+ uses: AndreasAugustin/actions-template-sync@v0.7.3
+ with:
+ github_token: ${{ secrets.GITHUB_TOKEN }}
+ source_repo_path: alshedivat/al-folio
+ upstream_branch: master
+```
+
+You will receive a pull request within your repository if there are some changes available in the template.
+
+Another option is to manually update your code by following the steps below:
```bash
# Assuming the current directory is
$ git remote add upstream https://github.com/alshedivat/al-folio.git
$ git fetch upstream
-$ git rebase upstream/v0.3.5
+$ git rebase v0.9.0
```
If you have extensively customized a previous version, it might be trickier to upgrade.
You can still follow the steps above, but `git rebase` may result in merge conflicts that must be resolved.
See [git rebase manual](https://help.github.com/en/github/using-git/about-git-rebase) and how to [resolve conflicts](https://help.github.com/en/github/using-git/resolving-merge-conflicts-after-a-git-rebase) for more information.
-If rebasing is too complicated, we recommend to re-install the new version of the theme from scratch and port over your content and changes from the previous version manually.
+If rebasing is too complicated, we recommend re-installing the new version of the theme from scratch and port over your content and changes from the previous version manually.
+
+---
### FAQ
Here are some frequently asked questions.
If you have a different question, please ask using [Discussions](https://github.com/alshedivat/al-folio/discussions/categories/q-a).
-1. **Q:** After I fork and setup the repo, I get a deployment error.
+1. **Q:** After I create a new repository from this template and setup the repo, I get a deployment error.
Isn't the website supposed to correctly deploy automatically?
**A:** Yes, if you are using release `v0.3.5` or later, the website will automatically and correctly re-deploy right after your first commit.
Please make some changes (e.g., change your website info in `_config.yml`), commit, and push.
@@ -225,9 +386,9 @@ If you have a different question, please ask using [Discussions](https://github.
But after deploying, it is not displayed correctly (CSS and JS is not loaded properly).
How do I fix that?
**A:** Make sure to correctly specify the `url` and `baseurl` paths in `_config.yml`.
- If you are deploying a personal or organization website to GitHub Pages, leave both fields blank.
- If you are deploying a project page to GitHub Pages, leave `url` blank and set `baseurl: //`.
- Generally, if you are deploying your webpage to `your-domain.com/your-project/`, you must set `url: your-domain.com` and `baseurl: /your-project/`.
+ Set `url` to `https://.github.io` or to `https://` if you are using a custom domain.
+ If you are deploying a personal or organization website, leave `baseurl` blank.
+ If you are deploying a project page, set `baseurl: //`.
4. **Q:** Atom feed doesn't work. Why?
@@ -235,28 +396,40 @@ If you have a different question, please ask using [Discussions](https://github.
RSS Feed plugin works with these correctly set up fields: `title`, `url`, `description` and `author`.
Make sure to fill them in an appropriate way and try again.
+5. **Q:** My site doesn't work when I enable `related_blog_posts`. Why?
+ **A:** This is probably due to the [classifier reborn](https://github.com/jekyll/classifier-reborn) plugin, which is used to calculate
+ related posts. If the error states `Liquid Exception: Zero vectors can not be normalized...`, it means that it could not calculate related
+ posts for a specific post. This is usually caused by [empty or minimal blog posts](https://github.com/jekyll/classifier-reborn/issues/64)
+ without meaningful words (i.e. only [stop words](https://en.wikipedia.org/wiki/Stop_words)) or even
+ [specific characters](https://github.com/jekyll/classifier-reborn/issues/194) you used in your posts. Also, the calculus for similar posts are
+ made for every `post`, which means every page that uses `layout: post`, including the announcements. To change this behavior, simply add
+ `related_posts: false` to the front matter of the page you don't want to display related posts on.
+
## Features
### Publications
-Your publications page is generated automatically from your BibTex bibliography.
+Your publications' page is generated automatically from your BibTex bibliography.
Simply edit `_bibliography/papers.bib`.
You can also add new `*.bib` files and customize the look of your publications however you like by editing `_pages/publications.md`.
-Author annotation:
+(click to expand) Author annotation:
-In publications, the author entry for yourself is identified by string `scholar:last_name` and string array `scholar:first_name` in `_config.yml`:
-```
+In publications, the author entry for yourself is identified by string array `scholar:last_name` and string array `scholar:first_name` in `_config.yml`:
+
+```yaml
scholar:
- last_name: Einstein
+ last_name: [Einstein]
first_name: [Albert, A.]
```
-If the entry matches the last name and one form of the first names, it will be underlined.
+
+If the entry matches one form of the last names and the first names, it will be underlined.
Keep meta-information about your co-authors in `_data/coauthors.yml` and Jekyll will insert links to their webpages automatically.
-The coauthor data format in `_data/coauthors.yml` is as follows,
-```
+The co-author data format in `_data/coauthors.yml` is as follows,
+
+```yaml
"Adams":
- firstname: ["Edwin", "E.", "E. P.", "Edwin Plimpton"]
url: https://en.wikipedia.org/wiki/Edwin_Plimpton_Adams
@@ -276,10 +449,35 @@ The coauthor data format in `_data/coauthors.yml` is as follows,
- firstname: ["Carl Philipp Emanuel", "C. P. E."]
url: https://en.wikipedia.org/wiki/Carl_Philipp_Emanuel_Bach
```
+
If the entry matches one of the combinations of the last names and the first names, it will be highlighted and linked to the url provided.
+(click to expand) Buttons (through custom bibtex keywords):
+
+There are several custom bibtex keywords that you can use to affect how the entries are displayed on the webpage:
+
+- `abbr`: Adds an abbreviation to the left of the entry. You can add links to these by creating a venue.yaml-file in the _data folder and adding entries that match.
+- `abstract`: Adds an "Abs" button that expands a hidden text field when clicked to show the abstract text
+- `arxiv`: Adds a link to the Arxiv website (Note: only add the arxiv identifier here - the link is generated automatically)
+- `bibtex_show`: Adds a "Bib" button that expands a hidden text field with the full bibliography entry
+- `html`: Inserts an "HTML" button redirecting to the user-specified link
+- `pdf`: Adds a "PDF" button redirecting to a specified file (if a full link is not specified, the file will be assumed to be placed in the /assets/pdf/ directory)
+- `supp`: Adds a "Supp" button to a specified file (if a full link is not specified, the file will be assumed to be placed in the /assets/pdf/ directory)
+- `blog`: Adds a "Blog" button redirecting to the specified link
+- `code`: Adds a "Code" button redirecting to the specified link
+- `poster`: Adds a "Poster" button redirecting to a specified file (if a full link is not specified, the file will be assumed to be placed in the /assets/pdf/ directory)
+- `slides`: Adds a "Slides" button redirecting to a specified file (if a full link is not specified, the file will be assumed to be placed in the /assets/pdf/ directory)
+- `website`: Adds a "Website" button redirecting to the specified link
+- `altmetric`: Adds an [Altmetric](https://www.altmetric.com/) badge (Note: if DOI is provided just use `true`, otherwise only add the altmetric identifier here - the link is generated automatically)
+- `dimensions`: Adds a [Dimensions](https://www.dimensions.ai/) badge (Note: if DOI or PMID is provided just use `true`, otherwise only add the Dimensions' identifier here - the link is generated automatically)
+
+You can implement your own buttons by editing the bib.html file.
+
+
+
+---
### Collections
@@ -293,6 +491,7 @@ Items from the `projects` collection are displayed on a responsive grid on proje
You can easily create your own collections, apps, short stories, courses, or whatever your creative work is.
To do this, edit the collections in the `_config.yml` file, create a corresponding folder, and create a landing page for your collection, similar to `_pages/projects.md`.
+---
### Layouts
@@ -302,13 +501,13 @@ To do this, edit the collections in the `_config.yml` file, create a correspondi
The theme allows you to create blog posts in the [distill.pub](https://distill.pub/) style:
-
+
-For more details on how to create distill-styled posts using `` tags, please refer to [the example](https://alshedivat.github.io/al-folio/blog/2018/distill/).
+For more details on how to create distill-styled posts using `` tags, please refer to [the example](https://alshedivat.github.io/al-folio/blog/2021/distill/).
#### Full support for math & code
-**al-folio** supports fast math typesetting through [KaTeX](https://katex.org/) and code syntax highlighting using [GitHub style](https://github.com/jwarby/jekyll-pygments-themes):
+**al-folio** supports fast math typesetting through [MathJax](https://www.mathjax.org/) and code syntax highlighting using [GitHub style](https://github.com/jwarby/jekyll-pygments-themes):
@@ -322,19 +521,67 @@ Easily create beautiful grids within your blog posts and project pages:
+---
### Other features
+#### GitHub's repositories and user stats
+
+**al-folio** uses [github-readme-stats](https://github.com/anuraghazra/github-readme-stats) and [github-profile-trophy](https://github.com/ryo-ma/github-profile-trophy)
+to display GitHub repositories and user stats on the `/repositories/` page.
+
+Edit the `_data/repositories.yml` and change the `github_users` and `github_repos` lists to include your own GitHub profile and repositories to the `/repositories/` page.
+
+You may also use the following codes for displaying this in any other pages.
+
+```html
+
+{% if site.data.repositories.github_users %}
+
+ {% for user in site.data.repositories.github_users %}
+ {% include repository/repo_user.html username=user %}
+ {% endfor %}
+
+{% endif %}
+
+
+{% if site.repo_trophies.enabled %}
+{% for user in site.data.repositories.github_users %}
+ {% if site.data.repositories.github_users.size > 1 %}
+
{{ user }}
+ {% endif %}
+
+ {% include repository/repo_trophies.html username=user %}
+
+ {% for repo in site.data.repositories.github_repos %}
+ {% include repository/repo.html repository=repo %}
+ {% endfor %}
+
+{% endif %}
+```
+
#### Theming
-Six beautiful theme colors have been selected to choose from.
-The default is purple, but you can quickly change it by editing `$theme-color` variable in the `_sass/_themes.scss` file.
+
+A variety of beautiful theme colors have been selected for you to choose from.
+The default is purple, but you can quickly change it by editing the
+`--global-theme-color` variable in the `_sass/_themes.scss` file.
Other color variables are listed there as well.
+The stock theme color options available can be found at `_sass/variables.scss`.
+You can also add your own colors to this file assigning each a name for ease of
+use across the template.
#### Social media previews
+
**al-folio** supports preview images on social media.
To enable this functionality you will need to set `serve_og_meta` to `true` in your `_config.yml`.
Once you have done so, all your site's pages will include Open Graph data in the HTML head element.
@@ -345,10 +592,18 @@ If for an individual page this variable is not set, then the theme will fall bac
In both the page-specific and site-wide cases, the `og_image` variable needs to hold the URL for the image you wish to display in social media previews.
#### Atom (RSS-like) Feed
+
It generates an Atom (RSS-like) feed of your posts, useful for Atom and RSS readers.
The feed is reachable simply by typing after your homepage `/feed.xml`.
E.g. assuming your website mountpoint is the main folder, you can type `yourusername.github.io/feed.xml`
+#### Related posts
+
+By default, there will be a related posts section on the bottom of the blog posts.
+These are generated by selecting the `max_related` most recent posts that share at least `min_common_tags` tags with the current post.
+If you do not want to display related posts on a specific post, simply add `related_posts: false` to the front matter of the post.
+If you want to disable it for all posts, simply set `enabled` to false in the `related_blog_posts` section in `_config.yml`.
+
## Contributing
Contributions to al-folio are very welcome!
@@ -357,10 +612,33 @@ Before you get started, please take a look at [the guidelines](CONTRIBUTING.md).
If you would like to improve documentation, add your webpage to the list below, or fix a minor inconsistency or bug, please feel free to send a PR directly to `master`.
For more complex issues/bugs or feature requests, please open an issue using the appropriate template.
+### Maintainers
+
+Our most active contributors are welcome to join the maintainers team.
+If you are interested, please reach out!
+
+
+
+
+
+
+
+
+
+
## License
-The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The theme is available as open source under the terms of the [MIT License](https://github.com/alshedivat/al-folio/blob/master/LICENSE).
-Originally, **al-folio** was based on the [\*folio theme](https://github.com/bogoli/-folio) (published by [Lia Bogoev](http://liabogoev.com) and under the MIT license).
+Originally, **al-folio** was based on the [\*folio theme](https://github.com/bogoli/-folio) (published by [Lia Bogoev](https://liabogoev.com) and under the MIT license).
Since then, it got a full re-write of the styles and many additional cool features.
diff --git a/_config.yml b/_config.yml
index 3fab69f08083..9f9591abeeda 100644
--- a/_config.yml
+++ b/_config.yml
@@ -193,32 +193,29 @@ enable_medium_zoom: true # enables image zoom feature (as on medium.co
# -----------------------------------------------------------------------------
academicons:
- version: "1.9.0"
- integrity: "sha512-W4yqoT1+8NLkinBLBZko+dFB2ZbHsYLDdr50VElllRcNt2Q4/GSs6u71UHKxB7S6JEMCp5Ve4xjh3eGQl/HRvg=="
+ version: "1.9.1"
+ integrity: "sha256-i1+4qU2G2860dGGIOJscdC30s9beBXjFfzjWLjBRsBg="
bootstrap:
- version: "4.5.2"
+ version: "4.6.1"
integrity:
- css: "sha512-MoRNloxbStBcD8z3M/2BmnT+rg4IsMxPkXaGh2zD6LGNNFE80W3onsAhRcMAMrSoyWL9xD7Ert0men7vR8LUZg=="
- js: "sha512-M5KW3ztuIICmVIhjSqXe01oV2bpe248gOxqmlcYrEzAvws7Pw3z6BK0iGbrwvdrUQUhi3eXgtxp5I8PDo9YfjQ=="
+ css: "sha256-DF7Zhf293AJxJNTmh5zhoYYIMs2oXitRfBjY+9L//AY="
+ js: "sha256-fgLAgv7fyCGopR/gBNq2iW3ZKIdqIcyshnUULC4vex8="
fontawesome:
- version: "5.14.0"
- integrity: "sha512-1PKOgIY59xJ8Co8+NE6FZ+LOAZKjy+KY8iq0G4B3CyeY6wYHN3yt9PW0XpSriVlkMXe40PTKnXrLnZ9+fkDaog=="
+ version: "5.15.4"
+ integrity: "sha256-mUZM63G8m73Mcidfrv5E+Y61y7a12O5mW4ezU3bxqW4="
jquery:
- version: "3.5.1"
- integrity: "sha512-bLT0Qm9VnAYZDflyKcBaQ2gg0hSYNQrJ8RilYldYQ1FxQYoCLtUjuuRuZo+fjqhx/qtq/1itJ0C2ejDxltZVFg=="
+ version: "3.6.0"
+ integrity: "sha256-/xUj+3OJU5yExlq6GSYGSHk7tPXikynS7ogEvDej/m4="
mathjax:
- version: "3.1.2"
-mansory:
+ version: "3.2.0"
+masonry:
version: "4.2.2"
integrity: "sha256-Nn1q/fx0H7SNLZMQ5Hw5JLaTRZp0yILA/FRexe19VdI="
mdb:
- version: "4.19.1"
+ version: "4.20.0"
integrity:
- css: "sha512-RO38pBRxYH3SoOprtPTD86JFOclM51/XTIdEPh5j8sj4tp8jmQIx26twG52UaLi//hQldfrh7e51WzP9wuP32Q=="
- js: "sha512-Mug9KHKmroQFMLm93zGrjhibM2z2Obg9l6qFG2qKjXEXkMp/VDkI4uju9m4QKPjWSwQ6O2qzZEnJDEeCw0Blcw=="
-popper:
- version: "2.4.4"
- integrity: "sha512-eUQ9hGdLjBjY3F41CScH3UX+4JDSI9zXeroz7hJ+RteoCaY+GP/LDoM8AO+Pt+DRFw3nXqsjh9Zsts8hnYv8/A=="
+ css: "sha256-jpjYvU3G3N6nrrBwXJoVEYI/0zw8htfFnhT9ljN3JJw="
+ js: "sha256-NdbiivsvWt7VYCt6hYNT3h/th9vSTL4EDWeGs5SN3DA="
medium_zoom:
- version: "1.0.6"
- integrity: "sha256-EdPgYcPk/IIrw7FYeuJQexva49pVRZNmt3LculEr7zM="
+ version: "1.0.8"
+ integrity: "sha256-7PhEpEWEW0XXQ0k6kQrPKwuoIomz8R8IYyuU1Qew4P8="
diff --git a/_data/cv.yml b/_data/cv.yml
new file mode 100644
index 000000000000..5b1157240e07
--- /dev/null
+++ b/_data/cv.yml
@@ -0,0 +1,97 @@
+- title: General Information
+ type: map
+ contents:
+ - name: Full Name
+ value: Albert Einstein
+ - name: Date of Birth
+ value: 14th March 1879
+ - name: Languages
+ value: English, German
+
+- title: Education
+ type: time_table
+ contents:
+ - title: PhD
+ institution: University of Zurich, Zurich, Switzerland
+ year: 1905
+ description:
+ - Description 1.
+ - Description 2.
+ - title: Description 3.
+ contents:
+ - Sub-description 1.
+ - Sub-description 2.
+ - title: Federal teaching diploma
+ institution: Eidgenössische Technische Hochschule, Zurich, Switzerland
+ year: 1900
+ description:
+ - Description 1.
+ - Description 2.
+
+- title: Experience
+ type: time_table
+ contents:
+ - title: Professor of Theoretical Physics
+ institution: Institute for Advanced Study, Princeton University
+ year: 1933 - 1955
+ description:
+ - Description 1.
+ - Description 2.
+ - title: Description 3.
+ contents:
+ - Sub-description 1.
+ - Sub-description 2.
+ - title: Visiting Professor
+ institution: California Institute of Technology, Pasadena, California, US
+ year: 1933
+ description:
+ - Description 1.
+ - Description 2.
+
+ - title: Director
+ institution: Kaiser Wilhelm Institute for Physics, Berlin, Germany.
+ year: 1917-1933
+
+ - title: Professor of Theoretical Physics
+ institution: Karl-Ferdinand University, Prague, Czechoslovakia
+ year: 1911 - 1917
+ description:
+
+ - title: Associate Professor of Theoretical Physics
+ institution: University of Zurich, Zurich, Switzerland
+ year: 1909 - 1911
+
+- title: Open Source Projects
+ type: time_table
+ contents:
+ - title: al-folio
+ year: 2015-now
+ description: A beautiful, simple, clean, and responsive Jekyll theme for academics.
+
+- title: Honors and Awards
+ type: time_table
+ contents:
+ - year: 1921
+ items:
+ - Nobel Prize in Physics
+ - Matteucci Medal
+ - year: 2029
+ items:
+ - Max Planck Medal
+
+- title: Academic Interests
+ type: nested_list
+ contents:
+ - title: Topic 1.
+ items:
+ - Description 1.
+ - Description 2.
+ - title: Topic 2.
+ items:
+ - Description 1.
+ - Description 2.
+
+- title: Other Interests
+ type: list
+ contents:
+ - Hobbies: Hobby 1, Hobby 2, etc.
diff --git a/_data/repositories.yml b/_data/repositories.yml
new file mode 100644
index 000000000000..5205c9f6f7e9
--- /dev/null
+++ b/_data/repositories.yml
@@ -0,0 +1,12 @@
+github_users:
+ - torvalds
+ - alshedivat
+
+github_repos:
+ - alshedivat/al-folio
+ - twbs/bootstrap
+ - jekyll/jekyll
+ - jquery/jquery
+ - FortAwesome/Font-Awesome
+ - jpswalsh/academicons
+ - mathjax/MathJax
diff --git a/_data/venues.yml b/_data/venues.yml
new file mode 100644
index 000000000000..6c16ad5dcbdf
--- /dev/null
+++ b/_data/venues.yml
@@ -0,0 +1,6 @@
+"AJP":
+ url: https://aapt.scitation.org/journal/ajp
+ color: "#00369f"
+
+"PhysRev":
+ url: https://journals.aps.org/
diff --git a/_includes/cv/list.html b/_includes/cv/list.html
new file mode 100644
index 000000000000..7562585916d3
--- /dev/null
+++ b/_includes/cv/list.html
@@ -0,0 +1,5 @@
+
+ {% for content in entry.contents %}
+
{{ content }}
+ {% endfor %}
+
\ No newline at end of file
diff --git a/_includes/cv/map.html b/_includes/cv/map.html
new file mode 100644
index 000000000000..e0d1983ef0ee
--- /dev/null
+++ b/_includes/cv/map.html
@@ -0,0 +1,8 @@
+
+ {% for content in entry.contents %}
+
+
{{ content.name }}
+
{{ content.value }}
+
+ {% endfor %}
+
\ No newline at end of file
diff --git a/_includes/cv/nested_list.html b/_includes/cv/nested_list.html
new file mode 100644
index 000000000000..4778aca07ff1
--- /dev/null
+++ b/_includes/cv/nested_list.html
@@ -0,0 +1,14 @@
+
+ {% for content in entry.contents %}
+
+
{{ content.title }}
+ {% if content.items %}
+
+ {% for subitem in content.items %}
+
{{ subitem }}
+ {% endfor %}
+
+ {% endif %}
+
+ {% endfor %}
+
\ No newline at end of file
diff --git a/_includes/cv/time_table.html b/_includes/cv/time_table.html
new file mode 100644
index 000000000000..123b9d099fde
--- /dev/null
+++ b/_includes/cv/time_table.html
@@ -0,0 +1,59 @@
+
+ {% for content in entry.contents %}
+
+
+ {% if content.year %}
+
+
+ {{ content.year }}
+
+
+ {% endif %}
+
+ {% if content.title %}
+
{{content.title}}
+ {% endif %}
+ {% if content.institution %}
+
{{content.institution}}
+ {% endif %}
+ {% if content.description %}
+
+ {% for item in content.description %}
+
+ {% if item.contents %}
+ {{ item.title }}
+
+ {% for subitem in item.contents %}
+
{{ subitem }}
+ {% endfor %}
+
+ {% else %}
+ {{ item }}
+ {% endif %}
+
+ {% endfor %}
+
+ {% endif %}
+ {% if content.items %}
+
+ {% for item in content.items %}
+
+ {% if item.contents %}
+ {{ item.title }}
+
+ {% for subitem in item.contents %}
+
{{ subitem }}
+ {% endfor %}
+
+ {% else %}
+ {{ item }}
+ {% endif %}
+
+ {% endfor %}
+
+ {% endif %}
+
+
+
+ {% endfor %}
+
\ No newline at end of file
diff --git a/_includes/disqus.html b/_includes/disqus.html
new file mode 100644
index 000000000000..73fe9538d0dc
--- /dev/null
+++ b/_includes/disqus.html
@@ -0,0 +1,13 @@
+
+
+
+
diff --git a/_includes/figure.html b/_includes/figure.html
new file mode 100644
index 000000000000..e67e8043f6c4
--- /dev/null
+++ b/_includes/figure.html
@@ -0,0 +1,36 @@
+{%- assign img_path = include.path | remove: ".jpg" | remove: ".jpeg" | remove: ".png" | remove: ".tiff" -%}
+
+
+
+
+ {% if site.imagemagick.enabled %}
+ {% for i in site.imagemagick.widths -%}
+
+ {% endfor -%}
+ {% endif %}
+
+
+
+
+
+
+ {%- if include.caption -%}{{ include.caption }}{%- endif %}
+
+
diff --git a/_includes/footer.html b/_includes/footer.html
index 2e3452184cfa..acc4688f7cff 100644
--- a/_includes/footer.html
+++ b/_includes/footer.html
@@ -1,27 +1,25 @@
-{% if site.footer_fixed %}
-
-{% else %}
-
-{% endif %}
+ {% if site.footer_fixed %}
+
+ {%- else -%}
+
+ {%- endif %}
\ No newline at end of file
diff --git a/_includes/giscus.html b/_includes/giscus.html
new file mode 100644
index 000000000000..bb504f64dbb8
--- /dev/null
+++ b/_includes/giscus.html
@@ -0,0 +1,27 @@
+
\ No newline at end of file
diff --git a/_includes/projects_horizontal.html b/_includes/projects_horizontal.html
index edecb9bfd811..ddf7405843c1 100644
--- a/_includes/projects_horizontal.html
+++ b/_includes/projects_horizontal.html
@@ -1,36 +1,36 @@
+ {{ year }}
+ {%- if tags != "" %}
+ ·
+ {% for tag in page.tags -%}
+
+ {{ tag }}
+ {% endfor -%}
+ {% endif %}
+
+ {%- if categories != "" %}
+ ·
+ {% for category in page.categories -%}
+
+ {{ category }}
+ {% endfor -%}
+ {% endif %}
+
+
{{ content }}
- {% if site.disqus_shortname and page.comments %}
-
-
-
- {% endif %}
+ {%- if site.related_blog_posts.enabled -%}
+ {%- if page.related_posts == null or page.related_posts -%}
+ {% include related_posts.html %}
+ {%- endif %}
+ {%- endif %}
+
+ {%- if site.disqus_shortname and page.disqus_comments -%}
+ {% include disqus.html %}
+ {%- endif %}
+ {%- if site.giscus.repo and page.giscus_comments -%}
+ {% include giscus.html %}
+ {%- endif -%}
diff --git a/_news/announcement_1.md b/_news/announcement_1.md
index 98e5af5c8786..e5349ced3893 100644
--- a/_news/announcement_1.md
+++ b/_news/announcement_1.md
@@ -2,6 +2,7 @@
layout: post
date: 2015-10-22 15:59:00-0400
inline: true
+related_posts: false
---
A simple inline announcement.
diff --git a/_news/announcement_2.md b/_news/announcement_2.md
index b086a49cc285..9de9588c5172 100644
--- a/_news/announcement_2.md
+++ b/_news/announcement_2.md
@@ -3,13 +3,14 @@ layout: post
title: A long announcement with details
date: 2015-11-07 16:11:00-0400
inline: false
+related_posts: false
---
Announcements and news can be much longer than just quick inline posts. In fact, they can have all the features available for the standard blog posts. See below.
***
-Jean shorts raw denim Vice normcore, art party High Life PBR skateboard stumptown vinyl kitsch. Four loko meh 8-bit, tousled banh mi tilde forage Schlitz dreamcatcher twee 3 wolf moon. Chambray asymmetrical paleo salvia, sartorial umami four loko master cleanse drinking vinegar brunch. Pinterest DIY authentic Schlitz, hoodie Intelligentsia butcher trust fund brunch shabby chic Kickstarter forage flexitarian. Direct trade cold-pressed meggings stumptown plaid, pop-up taxidermy. Hoodie XOXO fingerstache scenester Echo Park. Plaid ugh Wes Anderson, freegan pug selvage fanny pack leggings pickled food truck DIY irony Banksy.
+Jean shorts raw denim Vice normcore, art party High Life PBR skateboard stumptown vinyl kitsch. Four loko meh 8-bit, tousled banh mi tilde forage Schlitz dreamcatcher twee 3 wolf moon. Chambray asymmetrical paleo salvia, sartorial umami four loko master cleanse drinking vinegar brunch. Pinterest DIY authentic Schlitz, hoodie Intelligentsia butcher trust fund brunch shabby chic Kickstarter forage flexitarian. Direct trade cold-pressed meggings stumptown plaid, pop-up taxidermy. Hoodie XOXO fingerstache scenester Echo Park. Plaid ugh Wes Anderson, freegan pug selvage fanny pack leggings pickled food truck DIY irony Banksy.
#### Hipster list
diff --git a/_news/announcement_3.md b/_news/announcement_3.md
index d90721915e94..4d540883b38e 100644
--- a/_news/announcement_3.md
+++ b/_news/announcement_3.md
@@ -2,6 +2,7 @@
layout: post
date: 2016-01-15 07:59:00-0400
inline: true
+related_posts: false
---
A simple inline announcement with Markdown emoji! :sparkles: :smile:
diff --git a/_pages/cv.md b/_pages/cv.md
new file mode 100644
index 000000000000..65d016a8cd81
--- /dev/null
+++ b/_pages/cv.md
@@ -0,0 +1,8 @@
+---
+layout: cv
+permalink: /cv/
+title: cv
+nav: true
+nav_order: 4
+cv_pdf: example_pdf.pdf
+---
diff --git a/_pages/dropdown.md b/_pages/dropdown.md
new file mode 100644
index 000000000000..7ac657417590
--- /dev/null
+++ b/_pages/dropdown.md
@@ -0,0 +1,13 @@
+---
+layout: page
+title: submenus
+nav: true
+nav_order: 6
+dropdown: true
+children:
+ - title: publications
+ permalink: /publications/
+ - title: divider
+ - title: projects
+ permalink: /projects/
+---
\ No newline at end of file
diff --git a/_pages/repositories.md b/_pages/repositories.md
new file mode 100644
index 000000000000..ee29f385f1a7
--- /dev/null
+++ b/_pages/repositories.md
@@ -0,0 +1,44 @@
+---
+layout: page
+permalink: /repositories/
+title: repositories
+description: Edit the `_data/repositories.yml` and change the `github_users` and `github_repos` lists to include your own GitHub profile and repositories.
+nav: true
+nav_order: 3
+---
+
+## GitHub users
+
+{% if site.data.repositories.github_users %}
+
+ {% for user in site.data.repositories.github_users %}
+ {% include repository/repo_user.html username=user %}
+ {% endfor %}
+
+
+---
+
+{% if site.repo_trophies.enabled %}
+{% for user in site.data.repositories.github_users %}
+ {% if site.data.repositories.github_users.size > 1 %}
+
{{ user }}
+ {% endif %}
+
+ {% include repository/repo_trophies.html username=user %}
+
+ 
- {% endif %}
- {% if page.profile.address %}
- 
+ {%- else -%}
+ {%- assign entry_path = entry.preview | prepend: '/assets/img/publication_preview/' -%}
+ {% include figure.html
+ path=entry_path
+ class="preview z-depth-1 rounded"
+ alt=entry.preview -%}
+ {%- endif -%}
+ {%- elsif entry.abbr -%}
+ {%- if site.data.venues[entry.abbr] -%}
+ {%- assign venue_style = nil -%}
+ {%- if site.data.venues[entry.abbr].color != blank -%}
+ {%- assign venue_style = site.data.venues[entry.abbr].color | prepend: 'style="background-color:' | append: '"' -%}
+ {%- endif -%}
+ {{entry.abbr}}
+ {%- else -%}
+ {{entry.abbr}}
+ {%- endif -%}
+ {%- endif -%}
+