+
+## User community
+
+The vibrant community of **al-folio** users is growing!
+Academics around the world use this theme for their homepages, blogs, lab pages, as well as webpages for courses, workshops, conferences, meetups, and more.
+Check out the community webpages below.
+Feel free to add your own page(s) by sending a PR.
+
+
+ICLR Blog Post Track (2023, 2024)
+ML Retrospectives (NeurIPS: 2019, 2020; ICML: 2020)
+HAMLETS (NeurIPS: 2020)
+ICBINB (NeurIPS: 2020, 2021)
+Neural Compression (ICLR: 2021)
+Score Based Methods (NeurIPS: 2022)
+Images2Symbols (CogSci: 2022)
+Medical Robotics Junior Faculty Forum (ISMR: 2023)
+Beyond Vision: Physics meets AI (ICIAP: 2023)
+Workshop on Diffusion Models (NeurIPS: 2023)
+
+
+
+
+## Lighthouse PageSpeed Insights
+
+### Desktop
+
+[](https://htmlpreview.github.io/?https://github.com/alshedivat/al-folio/blob/master/lighthouse_results/desktop/alshedivat_github_io_al_folio_.html)
+
+Run the test yourself: [Google Lighthouse PageSpeed Insights](https://pagespeed.web.dev/report?url=https%3A%2F%2Falshedivat.github.io%2Fal-folio%2F&form_factor=desktop)
+
+### Mobile
+
+[](https://htmlpreview.github.io/?https://github.com/alshedivat/al-folio/blob/master/lighthouse_results/mobile/alshedivat_github_io_al_folio_.html)
+
+Run the test yourself: [Google Lighthouse PageSpeed Insights](https://pagespeed.web.dev/report?url=https%3A%2F%2Falshedivat.github.io%2Fal-folio%2F&form_factor=mobile)
+
+## Table Of Contents
+
+- [al-folio](#al-folio)
+ - [User community](#user-community)
+ - [Lighthouse PageSpeed Insights](#lighthouse-pagespeed-insights)
+ - [Desktop](#desktop)
+ - [Mobile](#mobile)
+ - [Table Of Contents](#table-of-contents)
+ - [Getting started](#getting-started)
+ - [Installing and Deploying](#installing-and-deploying)
+ - [Customizing](#customizing)
+ - [Features](#features)
+ - [Light/Dark Mode](#lightdark-mode)
+ - [CV](#cv)
+ - [People](#people)
+ - [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, Audio, Video and more](#photos-audio-video-and-more)
+ - [Other features](#other-features)
+ - [GitHub's repositories and user stats](#githubs-repositories-and-user-stats)
+ - [Theming](#theming)
+ - [Social media previews](#social-media-previews)
+ - [Atom (RSS-like) Feed](#atom-rss-like-feed)
+ - [Related posts](#related-posts)
+ - [Code quality checks](#code-quality-checks)
+ - [FAQ](#faq)
+ - [Contributing](#contributing)
+ - [Maintainers](#maintainers)
+ - [All Contributors](#all-contributors)
+ - [Star History](#star-history)
+ - [License](#license)
+
+## Getting started
+
+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/)! Why write a blog? Read [Rachel Thomas blog post](https://medium.com/@racheltho/why-you-yes-you-should-blog-7d2544ac1045).
+
+## Installing and Deploying
+
+For installation and deployment details please refer to [INSTALL.md](INSTALL.md).
+
+## Customizing
+
+For customization details please refer to [CUSTOMIZE.md](CUSTOMIZE.md).
+
+## Features
+
+### Light/Dark Mode
+
+This template has a built-in light/dark mode. It detects the user preferred color scheme and automatically switches to it. You can also manually switch between light and dark mode by clicking on the sun/moon icon in the top right corner of the page.
+
+
+
+
+
+
+---
+
+### CV
+
+There are currently 2 different ways of generating the CV page content. The first one is by using a json file located in [assets/json/resume.json](assets/json/resume.json). It is a [known standard](https://jsonresume.org/) for creating a CV programmatically. The second one, currently used as a fallback when the json file is not found, is by using a yml file located in [\_data/cv.yml](_data/cv.yml). This was the original way of creating the CV page content and since it is more human readable than a json file we decided to keep it as an option.
+
+What this means is, if there is no resume data defined in [\_config.yml](_config.yml) and loaded via a json file, it will load the contents of [\_data/cv.yml](_data/cv.yml) as fallback.
+
+[](https://alshedivat.github.io/al-folio/cv/)
+
+---
+
+### People
+
+You can create a people page if you want to feature more than one person. Each person can have its own short bio, profile picture, and you can also set if every person will appear at the same or opposite sides.
+
+[](https://alshedivat.github.io/al-folio/people/)
+
+---
+
+### Publications
+
+Your publications' page is generated automatically from your BibTex bibliography. Simply edit [\_bibliography/papers.bib](_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](_pages/publications.md). By default, the publications will be sorted by year and the most recent will be displayed first. You can change this behavior and more in the `Jekyll Scholar` section in [\_config.yml](_config.yml) file.
+
+You can add extra information to a publication, like a PDF file in the [assets/pdf/](assets/pdf/) directory and add the path to the PDF file in the BibTeX entry with the `pdf` field. Some of the supported fields are: `abstract`, `altmetric`, `arxiv`, `bibtex_show`, `blog`, `code`, `dimensions`, `doi`, `eprint`, `html`, `isbn`, `pdf`, `pmid`, `poster`, `slides`, `supp`, `video`, and `website`.
+
+[](https://alshedivat.github.io/al-folio/publications/)
+
+---
+
+### Collections
+
+This Jekyll theme implements `collections` to let you break up your work into categories. The theme comes with two default collections: `news` and `projects`. Items from the `news` collection are automatically displayed on the home page. Items from the `projects` collection are displayed on a responsive grid on projects page.
+
+[](https://alshedivat.github.io/al-folio/projects/)
+
+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](_config.yml) file, create a corresponding folder, and create a landing page for your collection, similar to `_pages/projects.md`.
+
+---
+
+### Layouts
+
+**al-folio** comes with stylish layouts for pages and blog posts.
+
+#### The iconic style of Distill
+
+The theme allows you to create blog posts in the [distill.pub](https://distill.pub/) style:
+
+[](https://alshedivat.github.io/al-folio/blog/2021/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 [MathJax](https://www.mathjax.org/) and code syntax highlighting using [GitHub style](https://github.com/jwarby/jekyll-pygments-themes). Also supports [chartjs charts](https://www.chartjs.org/), [mermaid diagrams](https://mermaid-js.github.io/mermaid/#/), and [TikZ figures](https://tikzjax.com/).
+
+
+
+
+
+
+#### Photos, Audio, Video and more
+
+Photo formatting is made simple using [Bootstrap's grid system](https://getbootstrap.com/docs/4.4/layout/grid/). Easily create beautiful grids within your blog posts and project pages, also with support for [video](https://alshedivat.github.io/al-folio/blog/2023/videos/) and [audio](https://alshedivat.github.io/al-folio/blog/2023/audios/) embeds:
+
+
+
+---
+
+### 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.
+
+[](https://alshedivat.github.io/al-folio/repositories/)
+
+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.liquid 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.liquid username=user %}
+
+ {% for repo in site.data.repositories.github_repos %} {% include repository/repo.liquid repository=repo %} {% endfor %}
+
+{% endif %}
+```
+
+---
+
+#### Theming
+
+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](_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](_config.yml). Once you have done so, all your site's pages will include Open Graph data in the HTML head element.
+
+You will then need to configure what image to display in your site's social media previews. This can be configured on a per-page basis, by setting the `og_image` page variable. If for an individual page this variable is not set, then the theme will fall back to a site-wide `og_image` variable, configurable in your [\_config.yml](_config.yml). 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](_config.yml).
+
+---
+
+#### Code quality checks
+
+Currently, we run some checks to ensure that the code quality and generated site are good. The checks are done using GitHub Actions and the following tools:
+
+- [Prettier](https://prettier.io/) - check if the formatting of the code follows the style guide
+- [lychee](https://lychee.cli.rs/) - check for broken links
+- [Axe](https://github.com/dequelabs/axe-core) (need to run manually) - do some accessibility testing
+
+We decided to keep `Axe` runs manual because fixing the issues are not straightforward and might be hard for people without web development knowledge.
+
+## FAQ
+
+For frequently asked questions, please refer to [FAQ.md](FAQ.md).
+
+## Contributing
+
+Contributions to al-folio are very welcome! Before you get started, please take a look at [the guidelines](CONTRIBUTING.md).
+
+If you would like to improve documentation 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!
+
+
+
+
+
+
+
+
+
+
+
+### All Contributors
+
+
+
+
+
+## Star History
+
+
+
+
+
+
+
+
+
+## License
+
+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](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/docs/_config.yml b/docs/_config.yml
index 0c2daee..bfc30f5 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -2,23 +2,26 @@
# Site settings
# -----------------------------------------------------------------------------
-title: Prajyot Jadhav | JdeRobot x GSoC 2024 # the website title (if blank, full name will be used instead)
-first_name: JdeRobot |
-middle_name:
-last_name: GSoC 2024
-email: prajyotj04@gmail.com
-description:
+title: blank # the website title (if blank, full name will be used instead)
+first_name: You
+middle_name: R.
+last_name: Name
+email: you@example.com
+description: > # the ">" symbol means to ignore newlines until "footer_text:"
+ A simple, whitespace theme for academics. Based on [*folio](https://github.com/bogoli/-folio) design.
footer_text: >
- RoboticsAcademy: Migration to Gazebo Harmonic
Powered by Jekyll with al-folio theme.
-keywords: # add your own keywords or leave empty
+ Hosted by GitHub Pages.
+ Photos from Unsplash.
+keywords: jekyll, jekyll-theme, academic-website, portfolio-website # add your own keywords or leave empty
lang: en # the language of your site (for example: en, fr, cn, ru, etc.)
icon: ⚛️ # the emoji used as the favicon (alternatively, provide image name in /assets/img/)
-url: https://theroboticsclub.github.io # the base hostname & protocol for your site
-baseurl: /gsoc2024-Prajyot_Jadhav # the subpath of your site, e.g. /blog/. Leave blank for root
+url: "https://theroboticsclub.github.io" # the base hostname & protocol for your site
+baseurl: "/gsoc2024-Prajyot_Jadhav" # the subpath of your site, e.g. /blog/. Leave blank for root
last_updated: false # set to true if you want to display last updated in the footer
impressum_path: # set to path to include impressum link in the footer, use the same path as permalink in a page, helps to conform with EU GDPR
+back_to_top: true # set to false to disable the back to top button
# -----------------------------------------------------------------------------
# Theme
@@ -38,7 +41,7 @@ repo_trophies:
# will use title and url fields
# Take a look to https://github.com/jekyll/jekyll-feed for more customization
-rss_icon: false
+rss_icon: true
# -----------------------------------------------------------------------------
# Layout
@@ -46,9 +49,11 @@ rss_icon: false
navbar_fixed: true
footer_fixed: true
+search_enabled: true
+socials_in_search: true
# Dimensions
-max_width: 800px
+max_width: 930px
# TODO: add layout settings (single page vs. multi-page)
@@ -72,7 +77,7 @@ dblp_url: # your DBLP profile url
discord_id: # your discord id (18-digit unique numerical identifier)
facebook_id: # your facebook id
flickr_id: # your flickr id
-github_username: Arcane-01 # your GitHub user name
+github_username: # your GitHub user name
gitlab_username: # your GitLab user name
ieee_id: # your ieeexplore.ieee.org/author/id
instagram_id: # your instagram id
@@ -80,7 +85,7 @@ kaggle_id: # your kaggle id
keybase_username: # your keybase user name
lastfm_id: # your lastfm id
lattes_id: # your ID on Lattes (Brazilian Lattes CV)
-linkedin_username: prajyot-jadhav-90921a241/ # your LinkedIn user name
+linkedin_username: # your LinkedIn user name
mastodon_username: # your mastodon instance+username in the format instance.tld/@username
medium_username: # your Medium username
orcid_id: # your ORCID ID
@@ -89,7 +94,7 @@ pinterest_id: # your pinterest id
publons_id: # your ID on Publons
quora_username: # your Quora username
research_gate_profile: # your profile on ResearchGate
-scholar_userid: # qc6CJjYAAAAJ # your Google Scholar ID
+scholar_userid: qc6CJjYAAAAJ # your Google Scholar ID
scopus_id: # your profile on Scopus
semanticscholar_id: # your Semantic Scholar ID
spotify_id: # your spotify id
@@ -101,11 +106,12 @@ whatsapp_number: # your WhatsApp number (full phone number in international form
wikidata_id: # your wikidata id
wikipedia_id: # your wikipedia id (Case sensitive)
work_url: # work page URL
-x_username: Arcane_01 # your X handle
+x_username: # your X handle
youtube_id: # your youtube channel id (youtube.com/@)
zotero_username: # your zotero username
-contact_note:
+contact_note: >
+ You can even add a little note about which of these is the best way to reach you.
# -----------------------------------------------------------------------------
# Analytics and search engine verification
@@ -124,8 +130,8 @@ bing_site_verification: # out your bing-site-verification ID (Bing Webmaster)
# Blog
# -----------------------------------------------------------------------------
-blog_name: # blog_name will be displayed in your blog page
-blog_description: "Robotics-Academy: Migration to Gazebo Harmonic"
+blog_name: al-folio # blog_name will be displayed in your blog page
+blog_description: a simple whitespace theme for academics
permalink: /blog/:year/:title/
lsi: true # produce an index for related posts
@@ -160,8 +166,8 @@ disqus_shortname: al-folio # put your disqus shortname
# If you have blog posts published on medium.com or other external sources,
# you can display them in your blog by adding a link to the RSS feed.
external_sources:
- # - name: medium.com
- # rss_url: https://medium.com/@al-folio/feed
+ - name: medium.com
+ rss_url: https://medium.com/@al-folio/feed
# -----------------------------------------------------------------------------
# Collections
@@ -263,7 +269,7 @@ sass:
# -----------------------------------------------------------------------------
jekyll-minifier:
- exclude: ["robots.txt"]
+ exclude: ["robots.txt", "assets/js/search/*.js"]
uglifier_args:
harmony: true
@@ -282,10 +288,9 @@ jekyll-archives:
tag: "/blog/tag/:name/"
category: "/blog/category/:name/"
-# display_tags: ["formatting", "images", "links", "math", "code"] # these tags will be displayed on the front page of your blog
-# display_categories: ["blockquotes"] # these categories will be displayed on the front page of your blog
-display_tags: [] # these tags will be displayed on the front page of your blog
-display_categories: [] # these categories will be displayed on the front page of your blog
+display_tags: ["formatting", "images", "links", "math", "code"] # these tags will be displayed on the front page of your blog
+display_categories: ["blockquotes"] # these categories will be displayed on the front page of your blog
+
# -----------------------------------------------------------------------------
# Jekyll Scholar
# -----------------------------------------------------------------------------
diff --git a/docs/_includes/header.liquid b/docs/_includes/header.liquid
index 6a5829e..805280b 100644
--- a/docs/_includes/header.liquid
+++ b/docs/_includes/header.liquid
@@ -107,6 +107,14 @@
{% endif %}
{% endif %}
{% endfor %}
+ {% if site.search_enabled %}
+
+
+
+
+ {% endif %}
{% if site.enable_darkmode %}
diff --git a/docs/_includes/scripts/back_to_top.liquid b/docs/_includes/scripts/back_to_top.liquid
index 6ff79fe..c52765d 100644
--- a/docs/_includes/scripts/back_to_top.liquid
+++ b/docs/_includes/scripts/back_to_top.liquid
@@ -1,4 +1,6 @@
diff --git a/docs/_includes/scripts/search.liquid b/docs/_includes/scripts/search.liquid
new file mode 100644
index 0000000..919e621
--- /dev/null
+++ b/docs/_includes/scripts/search.liquid
@@ -0,0 +1,555 @@
+{% if site.search_enabled %}
+
+
+
+
+{% endif %}
diff --git a/docs/_layouts/default.liquid b/docs/_layouts/default.liquid
index 77b78b2..3f4af10 100644
--- a/docs/_layouts/default.liquid
+++ b/docs/_layouts/default.liquid
@@ -72,5 +72,6 @@
{% include scripts/imageLayouts.liquid %}
{% include scripts/jekyll_tabs.liquid %}
{% include scripts/back_to_top.liquid %}
+ {% include scripts/search.liquid %}
+
+
+
+
+
+
