diff --git a/.dockerignore b/.dockerignore deleted file mode 100644 index 7e82674..0000000 --- a/.dockerignore +++ /dev/null @@ -1,3 +0,0 @@ -_site/ -.git/ -assets/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 98685d4..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,37 +0,0 @@ -# Contributing to al-folio - -Thank you for considering contributing to al-folio! - -## Pull Requests - -We welcome your pull requests (PRs). -For minor fixes (e.g., documentation improvements), feel free to submit a PR directly. -If you would like to implement a new feature or a bug, please make sure you (or someone else) has opened an appropriate issue first; in your PR, please mention the issue it addresses. - -Note that since [#2048](https://github.com/alshedivat/al-folio/pull/2048) al-folio uses the [prettier formatter](https://prettier.io/) for its code, meaning all new submitted code must conform to its standard. If you don't have `prettier` installed for your setup and the `prettier` code check fails when submitting a PR, you can check the referred failed action in our repo. In that action there will be an artifact with an HTML diff showing the needed changes. - -### Adding new social media information - -To add new social media information, there are a few places you might need to modify. Currently, the template supports icons from [Academicons](https://jpswalsh.github.io/academicons/), [Font Awesome](https://fontawesome.com/), and [Tabler Icons](https://tabler.io/icons). For an example PR, check [Add HAL id to socials](https://github.com/alshedivat/al-folio/pull/3206/files). Note that the information in all these files are alphabetically sorted. - -- \_data/socials.yml - your social media information -- \_includes/metadata.liquid - add social media information to site metadata -- \_includes/social.liquid - where the social media icon will be displayed -- \_scripts/search.liquid.js - make the social media information appear in search - -## Issues - -We use GitHub issues to track bugs and feature requests. -Before submitting an issue, please make sure: - -1. You have read [the FAQ section](FAQ.md) 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 in the [Discussions](https://github.com/alshedivat/al-folio/discussions) forum. - -When submitting an issue, please make sure to use the appropriate template. - -## License - -By contributing to al-folio, you agree that your contributions will be licensed -under the LICENSE file in the root directory of the source tree. diff --git a/Dockerfile b/Dockerfile deleted file mode 100644 index 99109cd..0000000 --- a/Dockerfile +++ /dev/null @@ -1,76 +0,0 @@ -FROM ruby:slim - -# uncomment these if you are having this issue with the build: -# /usr/local/bundle/gems/jekyll-4.3.4/lib/jekyll/site.rb:509:in `initialize': Permission denied @ rb_sysopen - /srv/jekyll/.jekyll-cache/.gitignore (Errno::EACCES) -# ARG GROUPID=901 -# ARG GROUPNAME=ruby -# ARG USERID=901 -# ARG USERNAME=jekyll - -ENV DEBIAN_FRONTEND noninteractive - -LABEL authors="Amir Pourmand,George Araújo" \ - description="Docker image for al-folio academic template" \ - maintainer="Amir Pourmand" - -# uncomment these if you are having this issue with the build: -# /usr/local/bundle/gems/jekyll-4.3.4/lib/jekyll/site.rb:509:in `initialize': Permission denied @ rb_sysopen - /srv/jekyll/.jekyll-cache/.gitignore (Errno::EACCES) -# add a non-root user to the image with a specific group and user id to avoid permission issues -# RUN groupadd -r $GROUPNAME -g $GROUPID && \ -# useradd -u $USERID -m -g $GROUPNAME $USERNAME - -# install system dependencies -RUN apt-get update -y && \ - apt-get install -y --no-install-recommends \ - build-essential \ - curl \ - git \ - imagemagick \ - inotify-tools \ - locales \ - nodejs \ - procps \ - python3-pip \ - zlib1g-dev && \ - pip --no-cache-dir install --upgrade --break-system-packages nbconvert - -# clean up -RUN apt-get clean && \ - apt-get autoremove && \ - rm -rf /var/lib/apt/lists/* /var/cache/apt/archives/* /tmp/* - -# set the locale -RUN sed -i '/en_US.UTF-8/s/^# //g' /etc/locale.gen && \ - locale-gen - -# set environment variables -ENV EXECJS_RUNTIME=Node \ - JEKYLL_ENV=production \ - LANG=en_US.UTF-8 \ - LANGUAGE=en_US:en \ - LC_ALL=en_US.UTF-8 - -# create a directory for the jekyll site -RUN mkdir /srv/jekyll - -# copy the Gemfile and Gemfile.lock to the image -ADD Gemfile.lock /srv/jekyll -ADD Gemfile /srv/jekyll - -# set the working directory -WORKDIR /srv/jekyll - -# install jekyll and dependencies -RUN gem install --no-document jekyll bundler -RUN bundle install --no-cache - -EXPOSE 8080 - -COPY bin/entry_point.sh /tmp/entry_point.sh - -# uncomment this if you are having this issue with the build: -# /usr/local/bundle/gems/jekyll-4.3.4/lib/jekyll/site.rb:509:in `initialize': Permission denied @ rb_sysopen - /srv/jekyll/.jekyll-cache/.gitignore (Errno::EACCES) -# set the ownership of the jekyll site directory to the non-root user -# USER $USERNAME - -CMD ["/tmp/entry_point.sh"] diff --git a/FAQ.md b/FAQ.md deleted file mode 100644 index 03ed40a..0000000 --- a/FAQ.md +++ /dev/null @@ -1,139 +0,0 @@ -# Frequently Asked Questions - -Here are some frequently asked questions. If you have a different question, please check if it was not already answered in the Q&A section of the [GitHub Discussions](https://github.com/alshedivat/al-folio/discussions/categories/q-a). If not, feel free to ask a new question there. - - - -- [Frequently Asked Questions](#frequently-asked-questions) - - [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?](#after-i-create-a-new-repository-from-this-template-and-setup-the-repo-i-get-a-deployment-error-isnt-the-website-supposed-to-correctly-deploy-automatically) - - [I am using a custom domain (e.g., foo.com). My custom domain becomes blank in the repository settings after each deployment. How do I fix that?](#i-am-using-a-custom-domain-eg-foocom-my-custom-domain-becomes-blank-in-the-repository-settings-after-each-deployment-how-do-i-fix-that) - - [My webpage works locally. But after deploying, it fails to build and throws Unknown tag 'toc'. How do I fix that?](#my-webpage-works-locally-but-after-deploying-it-fails-to-build-and-throws-unknown-tag-toc-how-do-i-fix-that) - - [My webpage works locally. But after deploying, it is not displayed correctly (CSS and JS are not loaded properly). How do I fix that?](#my-webpage-works-locally-but-after-deploying-it-is-not-displayed-correctly-css-and-js-are-not-loaded-properly-how-do-i-fix-that) - - [Atom feed doesn't work. Why?](#atom-feed-doesnt-work-why) - - [My site doesn't work when I enable related_blog_posts. Why?](#my-site-doesnt-work-when-i-enable-related_blog_posts-why) - - [When trying to deploy, it's asking for github login credentials, which github disabled password authentication and it exits with an error. How to fix?](#when-trying-to-deploy-its-asking-for-github-login-credentials-which-github-disabled-password-authentication-and-it-exits-with-an-error-how-to-fix) - - [When I manually run the Lighthouse Badger workflow, it fails with Error: Input required and not supplied: token. How do I fix that?](#when-i-manually-run-the-lighthouse-badger-workflow-it-fails-with-error-input-required-and-not-supplied-token-how-do-i-fix-that) - - [My code runs fine locally, but when I create a commit and submit it, it fails with prettier code formatter workflow run failed for main branch. How do I fix that?](#my-code-runs-fine-locally-but-when-i-create-a-commit-and-submit-it-it-fails-with-prettier-code-formatter-workflow-run-failed-for-main-branch-how-do-i-fix-that) - - [After I update my site with some new content, even a small change, the GitHub action throws an error or displays a warning. What happened?](#after-i-update-my-site-with-some-new-content-even-a-small-change-the-github-action-throws-an-error-or-displays-a-warning-what-happened) - - [I am trying to deploy my site, but it fails with Could not find gem 'jekyll-diagrams' in locally installed gems. How do I fix that?](#i-am-trying-to-deploy-my-site-but-it-fails-with-could-not-find-gem-jekyll-diagrams-in-locally-installed-gems-how-do-i-fix-that) - - [How can I update Academicons version on the template](#how-can-i-update-academicons-version-on-the-template) - - [How can I update Font Awesome version on the template](#how-can-i-update-font-awesome-version-on-the-template) - - [How can I update Tabler Icons version on the template](#how-can-i-update-tabler-icons-version-on-the-template) - - [What do all these GitHub actions/workflows mean?](#what-do-all-these-github-actionsworkflows-mean) - - [How can I use Google Search Console ID on the template?](#how-can-i-use-google-search-console-id-on-the-template) - - - -## 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? - -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. Make sure to follow [deployment instructions](https://github.com/alshedivat/al-folio#deployment). (Relevant issue: [209](https://github.com/alshedivat/al-folio/issues/209#issuecomment-798849211).) - -## I am using a custom domain (e.g., `foo.com`). My custom domain becomes blank in the repository settings after each deployment. How do I fix that? - -You need to add `CNAME` file to the `main` or `source` branch of your repository. The file should contain your custom domain name. (Relevant issue: [130](https://github.com/alshedivat/al-folio/issues/130).) - -## My webpage works locally. But after deploying, it fails to build and throws `Unknown tag 'toc'`. How do I fix that? - -Make sure you followed through the [deployment instructions](#deployment) in the previous section. You should have set the deployment branch to `gh-pages`. (Related issue: [1438](https://github.com/alshedivat/al-folio/issues/1438).) - -## My webpage works locally. But after deploying, it is not displayed correctly (CSS and JS are not loaded properly). How do I fix that? - -If the website does not load the theme, the layout looks weird, and all links are broken, being the main page displayed this way: - - - -make sure to correctly specify the `url` and `baseurl` paths in `_config.yml`. 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` **empty** (do **NOT** delete it). If you are deploying a project page, set `baseurl: //`. If all previous steps were done correctly, all is missing is for your browser to fetch again the site stylesheet. For this, you can: - -- press [Shift + F5 on Chromium-based](https://support.google.com/chrome/answer/157179#zippy=%2Cwebpage-shortcuts) or [Ctrl + F5 on Firefox-based](https://support.mozilla.org/en-US/kb/keyboard-shortcuts-perform-firefox-tasks-quickly) browsers to reload the page ignoring cached content -- clean your browser history -- simply try it in a private session, here's how to do it in [Chrome](https://support.google.com/chrome/answer/95464) and [Firefox](https://support.mozilla.org/en-US/kb/private-browsing-use-firefox-without-history) - -## Atom feed doesn't work. Why? - -Make sure to correctly specify the `url` and `baseurl` paths in `_config.yml`. 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. - -## My site doesn't work when I enable `related_blog_posts`. Why? - -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...` or `sqrt': Numerical argument is out of domain - "sqrt"`, 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. Another solution is to disable the lsi (latent semantic indexing) entirely by setting the `lsi` flag to `false` in `_config.yml`. Related issue: [#1828](https://github.com/alshedivat/al-folio/issues/1828). - -## When trying to deploy, it's asking for github login credentials, which github disabled password authentication and it exits with an error. How to fix? - -Open .git/config file using your preferred editor. Change the `https` portion of the `url` variable to `ssh`. Try deploying again. - -## When I manually run the Lighthouse Badger workflow, it fails with `Error: Input required and not supplied: token`. How do I fix that? - -You need to [create a personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) and [add it as a secret](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions#creating-encrypted-secrets-for-a-repository) named `LIGHTHOUSE_BADGER_TOKEN` to your repository. For more information, check [lighthouse-badger documentation](https://github.com/MyActionWay/lighthouse-badger-workflows#lighthouse-badger-easyyml) on how to do this. - -## My code runs fine locally, but when I create a commit and submit it, it fails with `prettier code formatter workflow run failed for main branch`. How do I fix that? - -We implemented support for [Prettier code formatting](https://prettier.io/) in [#2048](https://github.com/alshedivat/al-folio/pull/2048). It basically ensures that your code is [well formatted](https://prettier.io/docs/en/). If you want to ensure your code is compliant with `Prettier`, you have a few options: - -- if you are running locally with `Docker` and using [development containers](https://github.com/alshedivat/al-folio/blob/main/INSTALL.md#local-setup-with-development-containers), `Prettier` is already included -- if you don't use `Docker`, it is simple to integrate it with your preferred IDE using an [extension](https://prettier.io/docs/en/editors) -- if you want to run it manually, you can follow the first 2 steps in [this tutorial](https://george-gca.github.io/blog/2023/slidev_for_non_web_devs/) (`Installing node version manager (nvm)` and `Installing Node (latest version)`), then, install it using `npm install prettier` inside the project directory, or install it globally on your computer using `npm install -g prettier`. To run `Prettier` on your current directory use `npx prettier . --write`. - -You can also disable it for your repo. For this, just delete the file [.github/workflows/prettier.yml](https://github.com/alshedivat/al-folio/blob/main/.github/workflows/prettier.yml). - -## After I update my site with some new content, even a small change, the GitHub action throws an error or displays a warning. What happened? - -Probably your GitHub workflow is throwing an error like this: - -```bash -/opt/hostedtoolcache/Ruby/3.0.2/x64/lib/ruby/gems/3.0.0/gems/bundler-2.5.5/lib/bundler/runtime.rb:304:in `check_for_activated_spec!': You have already activated uri 0.10.1, but your Gemfile requires uri 0.13.0. Since uri is a default gem, you can either remove your dependency on it or try updating to a newer version of bundler that supports uri as a default gem. (Gem::LoadError) -``` - -or maybe displaying a warning like one of these: - -``` -Node.js 16 actions are deprecated. Please update the following actions to use Node.js 20: actions/checkout@v3. For more information see: https://github.blog/changelog/2023-09-22-github-actions-transitioning-from-node-16-to-node-20/. -Node.js 16 actions are deprecated. Please update the following actions to use Node.js 20: actions/checkout@v2, actions/cache@v2. For more information see: https://github.blog/changelog/2023-09-22-github-actions-transitioning-from-node-16-to-node-20/. -The following actions uses node12 which is deprecated and will be forced to run on node16: actions/checkout@v2, actions/cache@v2. For more info: https://github.blog/changelog/2023-06-13-github-actions-all-actions-will-run-on-node16-instead-of-node12-by-default/ -The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/ -``` - -If that's the case, you are using deprecated libraries/commands. This happens because you are using a very old version of al-folio. To fix this it is recommended [upgrading your code to the latest version](INSTALL.md#upgrading-from-a-previous-version) of the template. You will probably need to do some manual merging. If you find it easier, you could create a copy of your repository, do a fresh installation from the template and reapply all your changes. For this I would recommend a tool like [meld](https://meldmerge.org/) or [winmerge](https://winmerge.org/) to check the differences between directories/files. - -Note that libraries tend to be deprecated and support for them dropped as they are no longer maintained, and keep using them involves security breaches. Also, some of these deprecations are enforced, for example, by GitHub itself, so there's so much we can do. We have also added tons of new functionality, as well as tidying things up and improving the overall speed and structure, so you could also benefit from these improvements. - -## I am trying to deploy my site, but it fails with `Could not find gem 'jekyll-diagrams' in locally installed gems`. How do I fix that? - -`jekyll-diagrams` support was dropped in [#1992](https://github.com/alshedivat/al-folio/pull/1992) in favor of using `mermaid.js` directly. Simply [update your code](INSTALL.md#upgrading-from-a-previous-version) to get the latest changes. - -## How can I update Academicons version on the template - -To update the Academicons version, you need to download the latest release from the [Academicons website](https://jpswalsh.github.io/academicons/). After downloading, extract the zip file and copy the files `academicons.ttf` and `academicons.woff` from the `fonts/` directory to `assets/fonts/` and the file `academicons.min.css` from the `css/` directory to `assets/css/`. - -## How can I update Font Awesome version on the template - -To update the Font Awesome version, you need to download the latest release "for the web" from the [Font Awesome website](https://fontawesome.com/download). After downloading, extract the zip file and copy the `scss/` directory content to `_sass/font-awesome/` and the `webfonts/` content to `assets/webfonts/`. - -## How can I update Tabler Icons version on the template - -To update the Tabler Icons version, you need to download the latest release from the [Tabler Icons website](https://tabler.io/icons). After downloading, extract the zip file and copy the files `tabler-icons-filled.scss`, `tabler-icons-outline.scss`, and `tabler-icons.scss` from the `webfont/` directory to `_sass/tabler-icons/`, and all the files from `webfont/fonts/` to `assets/fonts/`. - -## What do all these GitHub actions/workflows mean? - -GitHub actions are a way to automate tasks in the repository. They are defined in `.github/workflows/` directory. Each file in this directory is a workflow. Workflows are made up of one or more jobs, and each job runs on a virtual machine hosted by GitHub. You can see the status of the workflows in the `Actions` tab of your repository. For more information, check the [GitHub Actions documentation](https://docs.github.com/en/actions). - -Currently we have the following workflows: - -- `axe.yml`: does some accessibility testing in your site. It uses the [axe cli](https://github.com/dequelabs/axe-core-npm/tree/develop/packages/cli) tool with a chrome driver to render the webpage and allow the analysis. Must be run manually, since fixing some of the issues is not straightforward -- `broken-links-site.yml`: checks for broken links in your built website with the [lychee-action](https://github.com/lycheeverse/lychee-action) -- `broken-links.yml`: checks for broken links in your repository with the [lychee-action](https://github.com/lycheeverse/lychee-action) -- `deploy-docker-tag.yml`: adds some metadata to the docker image and pushes it to Docker Hub -- `deploy-image.yml`: deploys a new docker image with the latest changes to Docker Hub -- `deploy.yml`: deploys the website to GitHub Pages -- `docker-slim.yml`: deploys a smaller version of the docker image to Docker Hub with the [docker-slim-action](https://github.com/kitabisa/docker-slim-action) -- `lighthouse-badger.yml`: runs a [lighthouse](https://github.com/GoogleChrome/lighthouse) test for your site with the [lighthouse-badger-action](https://github.com/MyActionWay/lighthouse-badger-action), saving the results in the repository for easy inspecting, as can be seen [here](https://github.com/alshedivat/al-folio?tab=readme-ov-file#lighthouse-pagespeed-insights). For more information on how to enable this workflow, check our [FAQ question about it](https://github.com/alshedivat/al-folio/blob/main/FAQ.md#when-i-manually-run-the-lighthouse-badger-workflow-it-fails-with-error-input-required-and-not-supplied-token-how-do-i-fix-that) -- `prettier-comment-on-pr.yml`: not working. For now, this action is disabled. It was supposed to run prettier on the PRs and comment on them with the changes needed. For more information, check [issue 2115](https://github.com/alshedivat/al-folio/issues/2115) -- `prettier.yml`: runs [prettier](https://prettier.io/) on the code to ensure it is well formatted. For more information, check our [FAQ question about it](https://github.com/alshedivat/al-folio/blob/main/FAQ.md#my-code-runs-fine-locally-but-when-i-create-a-commit-and-submit-it-it-fails-with-prettier-code-formatter-workflow-run-failed-for-main-branch-how-do-i-fix-that) - -## How can I use Google Search Console ID on the template? - -In the configuration file `_config.yml` the tag `google-site-verification` should be updated to use this functionality. Here is how you can proceed, - -- Generate your HTML tag by following [https://support.google.com/webmasters/answer/9008080?hl=en#meta_tag_verification&zippy=%2Chtml-tag](https://support.google.com/webmasters/answer/9008080?hl=en#meta_tag_verification&zippy=%2Chtml-tag) with URL prefix option. -- In the verify ownership option choose HTML tag and copy the tag contents which should look like ``. -- The string against `content` is the Google Search Console ID that can be used in the template. e.g. `google-site-verification: GoogleSearchConsoleID`. Now set the property `enable_google_verification: true`. - -It looks like the Domain type property in the Google Search Console to verify the ownership of all URLs across all subdomains with GitHub Pages does not work. diff --git a/INSTALL.md b/INSTALL.md deleted file mode 100644 index b55a157..0000000 --- a/INSTALL.md +++ /dev/null @@ -1,253 +0,0 @@ -# Installing and Deploying - - - -- [Installing and Deploying](#installing-and-deploying) - - [Recommended Approach](#recommended-approach) - - [Local setup on Windows](#local-setup-on-windows) - - [Local setup using Docker (Recommended)](#local-setup-using-docker-recommended) - - [Build your own docker image](#build-your-own-docker-image) - - [Have Bugs on Docker Image?](#have-bugs-on-docker-image) - - [Local Setup with Development Containers](#local-setup-with-development-containers) - - [Local Setup (Legacy, no longer supported)](#local-setup-legacy-no-longer-supported) - - [Deployment](#deployment) - - [For personal and organization webpages](#for-personal-and-organization-webpages) - - [For project pages](#for-project-pages) - - [Enabling automatic deployment](#enabling-automatic-deployment) - - [Manual deployment to GitHub Pages](#manual-deployment-to-github-pages) - - [Deploy on Netlify](https://www.netlify.com/) - - [Deployment to another hosting server (non GitHub Pages)](#deployment-to-another-hosting-server-non-github-pages) - - [Deployment to a separate repository (advanced users only)](#deployment-to-a-separate-repository-advanced-users-only) - - [Upgrading from a previous version](#upgrading-from-a-previous-version) - - - -## Recommended Approach - -The recommended approach for using **al-folio** is to first create your own site using the template with as few changes as possible, and only when it is up and running customize it however you like. This way it is easier to pinpoint what causes a potential issue in case of a bug. The minimum steps required to create your own site are ([video tutorial here](assets/video/tutorial_al_folio.mp4)): - -1. Create a new repository using this template. For this, click on [Use this template -> Create a new repository](https://github.com/new?template_name=al-folio&template_owner=alshedivat) above the file list. If you plan to upload your site to `.github.io`, note that the name of your repository :warning: **MUST BE** :warning: `.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). -2. In this new repository, go to [Settings -> Actions -> General -> Workflow permissions](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-the-default-github_token-permissions) and give `Read and write permissions` to GitHub Actions. -3. Open file `_config.yml`, set `url` to `https://.github.io` and leave `baseurl` **empty** (do NOT delete it), as `baseurl:`. -4. Wait until the GitHub action with subtitle `Deploy site` finishes (check your repository **Actions** tab), which takes ~4 min. Now, in addition to the `main` branch, your repository has a newly built `gh-pages` branch. -5. Finally, in the repository page go to `Settings -> Pages -> Build and deployment`, make sure that `Source` is set to `Deploy from a branch` and set the branch to `gh-pages` (NOT to main). -6. Wait until the GitHub action `pages-build-deployment` finishes (check your repository **Actions** tab), which takes ~45s, then simply navigate to `https://.github.io` in your browser. At this point you should see a copy of the theme's [demo website](https://alshedivat.github.io/al-folio/). - After everything is set up, you can download the repository to your machine and start customizing it. To do so, run the following commands: - -```bash -$ git clone git@github.com:/.git -``` - -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: - -## Local setup on Windows - -If you are using Windows, it is **highly recommended** to use [Windows Subsystem for Linux (WSL)](https://learn.microsoft.com/en-us/windows/wsl/install), which is a compatibility layer for running Linux on top of Windows. You can follow [these instructions](https://ubuntu.com/tutorials/install-ubuntu-on-wsl2-on-windows-11-with-gui-support) to install WSL and Ubuntu on your machine. You only need to go up to the step 4 of the tutorial (you don't have to enable the optional `systemd` nor the graphical applications), and then you can follow the instructions below to install docker. You can install docker natively on Windows as well, but it has been having some issues as can be seen in [#1540](https://github.com/alshedivat/al-folio/issues/1540), [#2007](https://github.com/alshedivat/al-folio/issues/2007). - -## Local setup using Docker (Recommended) - -Using Docker to install Jekyll and Ruby dependencies is the easiest way. - -You need to take the following steps to get `al-folio` up and running on 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 the latest pre-built image from DockerHub and will run your website. - -```bash -$ docker compose pull -$ docker compose up -``` - -Note that when you run it for the first time, it will download a docker image of size 400MB or so. To see the template running, open your browser and go to `http://localhost:8080`. You should see a copy of the theme's demo website. - -Now, feel free to customize the theme however you like (don't forget to change the name!). Also, your changes should be automatically rendered in real-time (or maybe after a few seconds). - -> Beta: You can also use the slimmed docker image with a size below 100MBs and exact same functionality. Just use `docker compose -f docker-compose-slim.yml up` - -### 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 up --build -``` - -> 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 the previous command! It will download Ruby and Jekyll and install all Ruby packages again from scratch. - -If you want to use a specific docker version, you can do so by changing `latest` tag to `your_version` in `docker-compose.yaml`. For example, you might have created your website on `v0.10.0` and you want to stick with that. - -### Have Bugs on Docker Image? - -Sometimes, there might be some bugs in the current docker image. It might be version mismatch or anything. If you want to debug and easily solve the problem for yourself you can do the following steps: - -``` -docker compose up -d -docker compose logs -``` - -Then you can see the bug! You can enter the container via this command: - -``` -docker compose exec -it jekyll /bin/bash -``` - -Then you can run the script: - -``` -./bin/entry_point.sh -``` - -You might see problems for package dependecy or something which is not available. You can fix it now by using - -``` -bundle install -./bin/entry_point.sh -``` - -Most likely, this will solve the problem but it shouldn't really happen. So, please open a bug report for us. - -## Local Setup with Development Containers - -`al-folio` supports [Development Containers](https://containers.dev/supporting). -For example, when you open the repository with Visual Studio Code (VSCode), it prompts you to install the necessary extension and automatically install everything necessary. - -## Local Setup (Legacy, no longer supported) - -For a hands-on walkthrough of running al-folio locally without using Docker, check out [this cool blog post](https://george-gca.github.io/blog/2022/running-local-al-folio/) 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)_), and also [Python](https://www.python.org/) and [pip](https://pypi.org/project/pip/) (_hint: for ease of managing python packages, consider using a virtual environment, like [venv](https://docs.python.org/pt-br/3/library/venv.html) or [conda](https://docs.conda.io/en/latest/)_). - -```bash -$ bundle install -# assuming pip is your Python package manager -$ pip install jupyter -$ bundle exec jekyll serve -``` - -To see the template running, open your browser and go to `http://localhost:4000`. You should see a copy of the theme's [demo website](https://alshedivat.github.io/al-folio/). Now, feel free to customize the theme however you like. After you are done, remember to **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 **main branch**! :sparkles: - -### For personal and organization webpages - -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 to your main branch, commit, and push! -5. After deployment, the webpage will become available at `.github.io`. - -### For project 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 to your main branch, commit, and push! -4. After deployment, the webpage will become available at `.github.io//`. - -### Enabling 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 to your main branch. 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 `main` branch, your repository should now have a newly built `gh-pages` branch. **Do NOT touch this branch!** -5. Finally, in the **Settings** of your repository, in the Pages section, set the branch to `gh-pages` (**NOT** to `main`). 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 keep your site on another branch, open `.github/workflows/deploy.yml` **on the branch you keep your website on** and change `on->push->branches` and `on->pull\_request->branches` to the branch you keep your website on. This will trigger the action on pulls/pushes on that branch. The action will then deploy the website on the branch it was triggered from. - -### 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." - -### Deploy on [Netlify](https://www.netlify.com/) - -1. [Use this template -> Create a new repository](https://github.com/new?template_name=al-folio&template_owner=alshedivat). -2. Netlify: **Add new site** -> **Import an existing project** -> **GitHub** and give Netlify access to the repository you just created. -3. Netlify: In the deploy settings - - - Set **Branch to deploy** to `main` - - **Base directory** is empty - - Set **Build command** to `sed -i "s/^\(baseurl: \).*$/baseurl:/" _config.yml && bundle exec jekyll build` - - Set **Publish directory** to `_site` - -4. Netlify: Add the following two **environment variables** - - - | Key | Value | - | -------------- | -------------------------------------------------------------------------------------- | - | `JEKYLL_ENV` | `production` | - | `RUBY_VERSION` | set to the Ruby version found in `.github/workflows/deploy.yml` (for example, `3.3.5`) | - -5. Netlify: Click **Deploy** and wait for the site to be published. If you want to use your own domain name, follow the steps in [this documentation](https://docs.netlify.com/domains-https/custom-domains/). - -### 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 -``` - -which will (re-)generate the static webpage in the `_site/` folder. -Then simply copy the contents of the `_site/` directory to your hosting server. - -If you also want to remove unused css classes from your file, run: - -```bash -$ purgecss -c purgecss.config.js -``` - -which will replace the css files in the `_site/assets/css/` folder with the purged css files. - -**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, **do not delete it**. - -### 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` 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 -``` - -This will instruct jekyll to deploy the website under `$HOME/repo/publishing-source`. - -**Note:** Jekyll will clean `$HOME/repo/publishing-source` before building! - -The quote below is taken directly from the [jekyll configuration docs](https://jekyllrb.com/docs/configuration/options/): - -> Destination folders are cleaned on site builds -> -> The contents of `` are automatically cleaned, by default, when the site is built. Files or folders that are not created by your site will be removed. Some files could be retained by specifying them within the `` configuration directive. -> -> 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 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 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 v0.14.6 -``` - -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 re-installing the new version of the theme from scratch and port over your content and changes from the previous version manually. You can use tools like [meld](https://meldmerge.org/) -or [winmerge](https://winmerge.org/) to help in this process. diff --git a/README.md b/README.md index 7f797db..72d224f 100644 --- a/README.md +++ b/README.md @@ -1,492 +1,61 @@ -# al-folio +# StuckInLocalMinima -
+**A personal blog by Bruno Baruffaldi** +Senior Machine Learning Engineer | Deep Learning, Computer Vision & High-Performance software. -[![Preview](readme_preview/al-folio-preview.png)](https://alshedivat.github.io/al-folio/) - -**A simple, clean, and responsive [Jekyll](https://jekyllrb.com/) theme for academics.** - ---- - -[![deploy](https://github.com/alshedivat/al-folio/actions/workflows/deploy.yml/badge.svg)](https://github.com/alshedivat/al-folio/actions/workflows/deploy.yml) -[![Maintainers](https://img.shields.io/badge/maintainers-4-success.svg)](#maintainers) -[![GitHub contributors](https://img.shields.io/github/contributors/alshedivat/al-folio.svg)](https://github.com/alshedivat/al-folio/graphs/contributors/) -[![Docker Image Version](https://img.shields.io/docker/v/amirpourmand/al-folio?sort=semver&label=docker%20image&color=blueviolet)](https://hub.docker.com/r/amirpourmand/al-folio) -[![Docker Image Size](https://img.shields.io/docker/image-size/amirpourmand/al-folio?sort=date&label=docker%20image%20size&color=blueviolet)](https://hub.docker.com/r/amirpourmand/al-folio) -[![Docker Pulls](https://img.shields.io/docker/pulls/amirpourmand/al-folio?color=blueviolet)](https://hub.docker.com/r/amirpourmand/al-folio) - -[![GitHub release](https://img.shields.io/github/v/release/alshedivat/al-folio)](https://github.com/alshedivat/al-folio/releases/latest) -[![GitHub license](https://img.shields.io/github/license/alshedivat/al-folio?color=blue)](https://github.com/alshedivat/al-folio/blob/main/LICENSE) -[![GitHub stars](https://img.shields.io/github/stars/alshedivat/al-folio)](https://github.com/alshedivat/al-folio) -[![GitHub forks](https://img.shields.io/github/forks/alshedivat/al-folio)](https://github.com/alshedivat/al-folio/fork) - -
- -## 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. - - - - - - - - - - - - - - - - - - -
Academics -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -
Labs -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -★ -
Courses -CMU PGM (S-19)
-CMU DeepRL (S-21, F-21, S-22, F-22, S-23, F-23)
-CMU MMML (F-20, F-22)
-CMU AMMML (S-22, S-23)
-CMU ASI (S-23)
-CMU Distributed Systems (S-24) -
Conferences & workshops -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)
-Workshop on Structured Probabilistic Inference & Generative Modeling (ICML: 2023, 2024) -
- -## Lighthouse PageSpeed Insights - -### Desktop - -[![Google Lighthouse PageSpeed Insights](lighthouse_results/desktop/pagespeed.svg)](https://htmlpreview.github.io/?https://github.com/alshedivat/al-folio/blob/main/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 - -[![Google Lighthouse PageSpeed Insights](lighthouse_results/mobile/pagespeed.svg)](https://htmlpreview.github.io/?https://github.com/alshedivat/al-folio/blob/main/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. - -[![CV Preview](readme_preview/cv.png)](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. - -[![People Preview](readme_preview/people.png)](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`. - -[![Publications Preview](readme_preview/publications.png)](https://alshedivat.github.io/al-folio/publications/) +This repository hosts my personal website and blog, built with [Jekyll](https://jekyllrb.com/) and the [al-folio](https://github.com/alshedivat/al-folio) theme. --- -### 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. - -[![Projects Preview](readme_preview/projects.png)](https://alshedivat.github.io/al-folio/projects/) +## 📦 Repository Structure -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`. +- `_config.yml` – Global Jekyll and theme configuration. +- `_pages/about.md` – “About” page with my profile and bio. +- `_posts/` – Blog posts in Markdown format. +- `_data/socials.yml` – Social media links and icons. +- `_includes/`, `_layouts/`, `_sass/` – Theme components and styles. +- `assets/` – Static images, fonts, and scripts. +- `LICENSE` – Project license (MIT). --- -### Layouts +## 🛠️ Local Development -**al-folio** comes with stylish layouts for pages and blog posts. +### 1. Open in DevContainer -#### The iconic style of Distill +This project includes a VS Code DevContainer. +Open the command palette (`Ctrl+Shift+P`) and select **Remote-Containers: Reopen in Container**. -The theme allows you to create blog posts in the [distill.pub](https://distill.pub/) style: +### 2. Install Dependencies -[![Distill Preview](readme_preview/distill.png)](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. - -[![Repositories Preview](readme_preview/repositories.png)](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 %} -
-{% endfor %} {% endif %} - - -{% if site.data.repositories.github_repos %} -
- {% for repo in site.data.repositories.github_repos %} {% include repository/repo.liquid repository=repo %} {% endfor %} -
-{% endif %} +```bash +# Inside the DevContainer +bundle install +npm install # if you add JS plugins ``` ---- - -#### 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 +### 3. Start Jekyll -**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. +```bash +bundle exec jekyll serve --livereload +``` -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. +Your site will be available at http://localhost:4000 with live reloading. --- -#### 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` - ---- +## 📄 About the Author -#### Related posts +**Bruno Baruffaldi** 👋 +Senior Machine Learning Engineer and software developer. +Experience in embedded real-time inference (Nvidia Jetson), cloud-scale model serving, and high-performance optimization. +First engineer at [DeepAgro](https://deepagro.com), building AI systems for targeted herbicide spraying. -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). +**About the Blog** +“StuckInLocalMinima” is where I share lessons learned, experiments that (mostly) succeeded, and thoughts on ML projects and code. --- -#### 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 `main`. 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! - - - - - - - - - - - - - -

Maruan
Rohan Deb Sarkar
Amir Pourmand
George
- - - - - - -### All Contributors - - - - - -## Star History - - - - - - Star History Chart - - - -## License - -The theme is available as open source under the terms of the [MIT License](https://github.com/alshedivat/al-folio/blob/main/LICENSE). +## 📜 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. +This project is licensed under the terms described in [`LICENSE`](LICENSE). diff --git a/_config.yml b/_config.yml index 8169f12..9b542ed 100644 --- a/_config.yml +++ b/_config.yml @@ -238,13 +238,10 @@ terser: jekyll-archives: posts: - enabled: [year, tags, categories] # enables year, tag and category archives (remove if you need to disable one of them). + enabled: [year, tags] # enables year and tag archives (remove if you need to disable one of them). permalinks: year: "/blog/:year/" tags: "/blog/:type/:name/" - categories: "/blog/:type/:name/" - books: - enabled: [year, tags, categories] # enables year, tag and category archives (remove if you need to disable one of them). display_tags: ["machine-learning", "mlops", "deployment", "data"] # 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 diff --git a/_data/coauthors.yml b/_data/coauthors.yml index a88fc53..e69de29 100644 --- a/_data/coauthors.yml +++ b/_data/coauthors.yml @@ -1,34 +0,0 @@ -# "adams": -# - firstname: ["Edwin", "E.", "E. P.", "Edwin Plimpton"] -# url: https://en.wikipedia.org/wiki/Edwin_Plimpton_Adams - -# "podolsky": -# - firstname: ["Boris", "B.", "B. Y.", "Boris Yakovlevich"] -# url: https://en.wikipedia.org/wiki/Boris_Podolsky - -# "rosen": -# - firstname: ["Nathan", "N."] -# url: https://en.wikipedia.org/wiki/Nathan_Rosen - -# "bach": -# - firstname: ["Johann Sebastian", "J. S."] -# url: https://en.wikipedia.org/wiki/Johann_Sebastian_Bach - -# - firstname: ["Carl Philipp Emanuel", "C. P. E."] -# url: https://en.wikipedia.org/wiki/Carl_Philipp_Emanuel_Bach - -# "przibram": -# - firstname: ["Karl"] -# url: https://link.springer.com/article/10.1007/s00016-019-00242-z - -# "schrodinger": -# - firstname: ["Erwin"] -# url: https://en.wikipedia.org/wiki/Erwin_Schr%C3%B6dinger - -# "lorentz": -# - firstname: ["Hendrik Antoon"] -# url: https://en.wikipedia.org/wiki/Hendrik_Lorentz - -# "planck": -# - firstname: ["Max"] -# url: https://en.wikipedia.org/wiki/Max_Planck diff --git a/_news/announcement_1.md b/_news/announcement_1.md deleted file mode 100644 index e5349ce..0000000 --- a/_news/announcement_1.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -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 deleted file mode 100644 index 9269395..0000000 --- a/_news/announcement_2.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -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. - -#### Hipster list - -
    -
  • brunch
    • -
  • fixie
    • -
  • raybans
    • -
  • messenger bag
    • -
- -Hoodie Thundercats retro, tote bag 8-bit Godard craft beer gastropub. Truffaut Tumblr taxidermy, raw denim Kickstarter sartorial dreamcatcher. Quinoa chambray slow-carb salvia readymade, bicycle rights 90's yr typewriter selfies letterpress cardigan vegan. - ---- - -Pug heirloom High Life vinyl swag, single-origin coffee four dollar toast taxidermy reprehenderit fap distillery master cleanse locavore. Est anim sapiente leggings Brooklyn ea. Thundercats locavore excepteur veniam eiusmod. Raw denim Truffaut Schlitz, migas sapiente Portland VHS twee Bushwick Marfa typewriter retro id keytar. - -> We do not grow absolutely, chronologically. We grow sometimes in one dimension, and not in another, unevenly. We grow partially. We are relative. We are mature in one realm, childish in another. -> —Anais Nin - -Fap aliqua qui, scenester pug Echo Park polaroid irony shabby chic ex cardigan church-key Odd Future accusamus. Blog stumptown sartorial squid, gastropub duis aesthetic Truffaut vero. Pinterest tilde twee, odio mumblecore jean shorts lumbersexual. diff --git a/_news/announcement_3.md b/_news/announcement_3.md deleted file mode 100644 index 4d54088..0000000 --- a/_news/announcement_3.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -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/news.md b/_pages/news.md deleted file mode 100644 index 6223439..0000000 --- a/_pages/news.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -layout: page -title: news -permalink: /news/ ---- - -{% include news.liquid %} diff --git a/_projects/1_project.md b/_projects/1_project.md deleted file mode 100644 index ac87b64..0000000 --- a/_projects/1_project.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -layout: page -title: project 1 -description: with background image -img: assets/img/12.jpg -importance: 1 -category: work -related_publications: true ---- - -Every project has a beautiful feature showcase page. -It's easy to include images in a flexible 3-column grid format. -Make your photos 1/3, 2/3, or full width. - -To give your project a background in the portfolio page, just add the img tag to the front matter like so: - - --- - layout: page - title: project - description: a project with a background image - img: /assets/img/12.jpg - --- - -
-
- {% include figure.liquid loading="eager" path="assets/img/1.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
- {% include figure.liquid loading="eager" path="assets/img/3.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
- {% include figure.liquid loading="eager" path="assets/img/5.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
-
- Caption photos easily. On the left, a road goes through a tunnel. Middle, leaves artistically fall in a hipster photoshoot. Right, in another hipster photoshoot, a lumberjack grasps a handful of pine needles. -
-
-
- {% include figure.liquid loading="eager" path="assets/img/5.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
-
- This image can also have a caption. It's like magic. -
- -You can also put regular text between your rows of images, even citations {% cite einstein1950meaning %}. -Say you wanted to write a bit about your project before you posted the rest of the images. -You describe how you toiled, sweated, _bled_ for your project, and then... you reveal its glory in the next row of images. - -
-
- {% include figure.liquid path="assets/img/6.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
- {% include figure.liquid path="assets/img/11.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
-
- You can also have artistically styled 2/3 + 1/3 images, like these. -
- -The code is simple. -Just wrap your images with `
` and place them inside `
` (read more about the Bootstrap Grid system). -To make images responsive, add `img-fluid` class to each; for rounded corners and shadows use `rounded` and `z-depth-1` classes. -Here's the code for the last row of images above: - -{% raw %} - -```html -
-
- {% include figure.liquid path="assets/img/6.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
- {% include figure.liquid path="assets/img/11.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
-``` - -{% endraw %} diff --git a/_projects/2_project.md b/_projects/2_project.md deleted file mode 100644 index 25de228..0000000 --- a/_projects/2_project.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -layout: page -title: project 2 -description: a project with a background image and giscus comments -img: assets/img/3.jpg -importance: 2 -category: work -giscus_comments: true ---- - -Every project has a beautiful feature showcase page. -It's easy to include images in a flexible 3-column grid format. -Make your photos 1/3, 2/3, or full width. - -To give your project a background in the portfolio page, just add the img tag to the front matter like so: - - --- - layout: page - title: project - description: a project with a background image - img: /assets/img/12.jpg - --- - -
-
- {% include figure.liquid loading="eager" path="assets/img/1.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
- {% include figure.liquid loading="eager" path="assets/img/3.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
- {% include figure.liquid loading="eager" path="assets/img/5.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
-
- Caption photos easily. On the left, a road goes through a tunnel. Middle, leaves artistically fall in a hipster photoshoot. Right, in another hipster photoshoot, a lumberjack grasps a handful of pine needles. -
-
-
- {% include figure.liquid loading="eager" path="assets/img/5.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
-
- This image can also have a caption. It's like magic. -
- -You can also put regular text between your rows of images. -Say you wanted to write a little bit about your project before you posted the rest of the images. -You describe how you toiled, sweated, _bled_ for your project, and then... you reveal its glory in the next row of images. - -
-
- {% include figure.liquid path="assets/img/6.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
- {% include figure.liquid path="assets/img/11.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
-
- You can also have artistically styled 2/3 + 1/3 images, like these. -
- -The code is simple. -Just wrap your images with `
` and place them inside `
` (read more about the Bootstrap Grid system). -To make images responsive, add `img-fluid` class to each; for rounded corners and shadows use `rounded` and `z-depth-1` classes. -Here's the code for the last row of images above: - -{% raw %} - -```html -
-
- {% include figure.liquid path="assets/img/6.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
- {% include figure.liquid path="assets/img/11.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
-``` - -{% endraw %} diff --git a/_projects/3_project.md b/_projects/3_project.md deleted file mode 100644 index 4f981b4..0000000 --- a/_projects/3_project.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -layout: page -title: project 3 with very long name -description: a project that redirects to another website -img: assets/img/7.jpg -redirect: https://unsplash.com -importance: 3 -category: work ---- - -Every project has a beautiful feature showcase page. -It's easy to include images in a flexible 3-column grid format. -Make your photos 1/3, 2/3, or full width. - -To give your project a background in the portfolio page, just add the img tag to the front matter like so: - - --- - layout: page - title: project - description: a project with a background image - img: /assets/img/12.jpg - --- - -
-
- {% include figure.liquid loading="eager" path="assets/img/1.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
- {% include figure.liquid loading="eager" path="assets/img/3.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
- {% include figure.liquid loading="eager" path="assets/img/5.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
-
- Caption photos easily. On the left, a road goes through a tunnel. Middle, leaves artistically fall in a hipster photoshoot. Right, in another hipster photoshoot, a lumberjack grasps a handful of pine needles. -
-
-
- {% include figure.liquid loading="eager" path="assets/img/5.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
-
- This image can also have a caption. It's like magic. -
- -You can also put regular text between your rows of images. -Say you wanted to write a little bit about your project before you posted the rest of the images. -You describe how you toiled, sweated, _bled_ for your project, and then... you reveal its glory in the next row of images. - -
-
- {% include figure.liquid path="assets/img/6.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
- {% include figure.liquid path="assets/img/11.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
-
- You can also have artistically styled 2/3 + 1/3 images, like these. -
- -The code is simple. -Just wrap your images with `
` and place them inside `
` (read more about the Bootstrap Grid system). -To make images responsive, add `img-fluid` class to each; for rounded corners and shadows use `rounded` and `z-depth-1` classes. -Here's the code for the last row of images above: - -{% raw %} - -```html -
-
- {% include figure.liquid path="assets/img/6.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
- {% include figure.liquid path="assets/img/11.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
-``` - -{% endraw %} diff --git a/_projects/4_project.md b/_projects/4_project.md deleted file mode 100644 index 1144b9c..0000000 --- a/_projects/4_project.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -layout: page -title: project 4 -description: another without an image -img: -importance: 3 -category: fun ---- - -Every project has a beautiful feature showcase page. -It's easy to include images in a flexible 3-column grid format. -Make your photos 1/3, 2/3, or full width. - -To give your project a background in the portfolio page, just add the img tag to the front matter like so: - - --- - layout: page - title: project - description: a project with a background image - img: /assets/img/12.jpg - --- - -
-
- {% include figure.liquid loading="eager" path="assets/img/1.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
- {% include figure.liquid loading="eager" path="assets/img/3.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
- {% include figure.liquid loading="eager" path="assets/img/5.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
-
- Caption photos easily. On the left, a road goes through a tunnel. Middle, leaves artistically fall in a hipster photoshoot. Right, in another hipster photoshoot, a lumberjack grasps a handful of pine needles. -
-
-
- {% include figure.liquid loading="eager" path="assets/img/5.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
-
- This image can also have a caption. It's like magic. -
- -You can also put regular text between your rows of images. -Say you wanted to write a little bit about your project before you posted the rest of the images. -You describe how you toiled, sweated, _bled_ for your project, and then... you reveal its glory in the next row of images. - -
-
- {% include figure.liquid path="assets/img/6.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
- {% include figure.liquid path="assets/img/11.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
-
- You can also have artistically styled 2/3 + 1/3 images, like these. -
- -The code is simple. -Just wrap your images with `
` and place them inside `
` (read more about the Bootstrap Grid system). -To make images responsive, add `img-fluid` class to each; for rounded corners and shadows use `rounded` and `z-depth-1` classes. -Here's the code for the last row of images above: - -{% raw %} - -```html -
-
- {% include figure.liquid path="assets/img/6.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
- {% include figure.liquid path="assets/img/11.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
-``` - -{% endraw %} diff --git a/_projects/5_project.md b/_projects/5_project.md deleted file mode 100644 index 35c8e63..0000000 --- a/_projects/5_project.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -layout: page -title: project 5 -description: a project with a background image -img: assets/img/1.jpg -importance: 3 -category: fun ---- - -Every project has a beautiful feature showcase page. -It's easy to include images in a flexible 3-column grid format. -Make your photos 1/3, 2/3, or full width. - -To give your project a background in the portfolio page, just add the img tag to the front matter like so: - - --- - layout: page - title: project - description: a project with a background image - img: /assets/img/12.jpg - --- - -
-
- {% include figure.liquid loading="eager" path="assets/img/1.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
- {% include figure.liquid loading="eager" path="assets/img/3.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
- {% include figure.liquid loading="eager" path="assets/img/5.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
-
- Caption photos easily. On the left, a road goes through a tunnel. Middle, leaves artistically fall in a hipster photoshoot. Right, in another hipster photoshoot, a lumberjack grasps a handful of pine needles. -
-
-
- {% include figure.liquid loading="eager" path="assets/img/5.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
-
- This image can also have a caption. It's like magic. -
- -You can also put regular text between your rows of images. -Say you wanted to write a little bit about your project before you posted the rest of the images. -You describe how you toiled, sweated, _bled_ for your project, and then... you reveal its glory in the next row of images. - -
-
- {% include figure.liquid path="assets/img/6.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
- {% include figure.liquid path="assets/img/11.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
-
- You can also have artistically styled 2/3 + 1/3 images, like these. -
- -The code is simple. -Just wrap your images with `
` and place them inside `
` (read more about the Bootstrap Grid system). -To make images responsive, add `img-fluid` class to each; for rounded corners and shadows use `rounded` and `z-depth-1` classes. -Here's the code for the last row of images above: - -{% raw %} - -```html -
-
- {% include figure.liquid path="assets/img/6.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
- {% include figure.liquid path="assets/img/11.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
-``` - -{% endraw %} diff --git a/_projects/6_project.md b/_projects/6_project.md deleted file mode 100644 index 36ea874..0000000 --- a/_projects/6_project.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -layout: page -title: project 6 -description: a project with no image -img: -importance: 4 -category: fun ---- - -Every project has a beautiful feature showcase page. -It's easy to include images in a flexible 3-column grid format. -Make your photos 1/3, 2/3, or full width. - -To give your project a background in the portfolio page, just add the img tag to the front matter like so: - - --- - layout: page - title: project - description: a project with a background image - img: /assets/img/12.jpg - --- - -
-
- {% include figure.liquid loading="eager" path="assets/img/1.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
- {% include figure.liquid loading="eager" path="assets/img/3.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
- {% include figure.liquid loading="eager" path="assets/img/5.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
-
- Caption photos easily. On the left, a road goes through a tunnel. Middle, leaves artistically fall in a hipster photoshoot. Right, in another hipster photoshoot, a lumberjack grasps a handful of pine needles. -
-
-
- {% include figure.liquid loading="eager" path="assets/img/5.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
-
- This image can also have a caption. It's like magic. -
- -You can also put regular text between your rows of images. -Say you wanted to write a little bit about your project before you posted the rest of the images. -You describe how you toiled, sweated, _bled_ for your project, and then... you reveal its glory in the next row of images. - -
-
- {% include figure.liquid path="assets/img/6.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
- {% include figure.liquid path="assets/img/11.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
-
- You can also have artistically styled 2/3 + 1/3 images, like these. -
- -The code is simple. -Just wrap your images with `
` and place them inside `
` (read more about the Bootstrap Grid system). -To make images responsive, add `img-fluid` class to each; for rounded corners and shadows use `rounded` and `z-depth-1` classes. -Here's the code for the last row of images above: - -{% raw %} - -```html -
-
- {% include figure.liquid path="assets/img/6.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
- {% include figure.liquid path="assets/img/11.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
-``` - -{% endraw %} diff --git a/_projects/7_project.md b/_projects/7_project.md deleted file mode 100644 index f9522ce..0000000 --- a/_projects/7_project.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -layout: page -title: project 7 -description: with background image -img: assets/img/4.jpg -importance: 1 -category: work -related_publications: true ---- - -Every project has a beautiful feature showcase page. -It's easy to include images in a flexible 3-column grid format. -Make your photos 1/3, 2/3, or full width. - -To give your project a background in the portfolio page, just add the img tag to the front matter like so: - - --- - layout: page - title: project - description: a project with a background image - img: /assets/img/12.jpg - --- - -
-
- {% include figure.liquid loading="eager" path="assets/img/1.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
- {% include figure.liquid loading="eager" path="assets/img/3.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
- {% include figure.liquid loading="eager" path="assets/img/5.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
-
- Caption photos easily. On the left, a road goes through a tunnel. Middle, leaves artistically fall in a hipster photoshoot. Right, in another hipster photoshoot, a lumberjack grasps a handful of pine needles. -
-
-
- {% include figure.liquid loading="eager" path="assets/img/5.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
-
- This image can also have a caption. It's like magic. -
- -You can also put regular text between your rows of images, even citations {% cite einstein1950meaning %}. -Say you wanted to write a bit about your project before you posted the rest of the images. -You describe how you toiled, sweated, _bled_ for your project, and then... you reveal its glory in the next row of images. - -
-
- {% include figure.liquid path="assets/img/6.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
- {% include figure.liquid path="assets/img/11.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
-
- You can also have artistically styled 2/3 + 1/3 images, like these. -
- -The code is simple. -Just wrap your images with `
` and place them inside `
` (read more about the Bootstrap Grid system). -To make images responsive, add `img-fluid` class to each; for rounded corners and shadows use `rounded` and `z-depth-1` classes. -Here's the code for the last row of images above: - -{% raw %} - -```html -
-
- {% include figure.liquid path="assets/img/6.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
- {% include figure.liquid path="assets/img/11.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
-``` - -{% endraw %} diff --git a/_projects/8_project.md b/_projects/8_project.md deleted file mode 100644 index c607901..0000000 --- a/_projects/8_project.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -layout: page -title: project 8 -description: an other project with a background image and giscus comments -img: assets/img/9.jpg -importance: 2 -category: work -giscus_comments: true ---- - -Every project has a beautiful feature showcase page. -It's easy to include images in a flexible 3-column grid format. -Make your photos 1/3, 2/3, or full width. - -To give your project a background in the portfolio page, just add the img tag to the front matter like so: - - --- - layout: page - title: project - description: a project with a background image - img: /assets/img/12.jpg - --- - -
-
- {% include figure.liquid loading="eager" path="assets/img/1.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
- {% include figure.liquid loading="eager" path="assets/img/3.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
- {% include figure.liquid loading="eager" path="assets/img/5.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
-
- Caption photos easily. On the left, a road goes through a tunnel. Middle, leaves artistically fall in a hipster photoshoot. Right, in another hipster photoshoot, a lumberjack grasps a handful of pine needles. -
-
-
- {% include figure.liquid loading="eager" path="assets/img/5.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
-
- This image can also have a caption. It's like magic. -
- -You can also put regular text between your rows of images. -Say you wanted to write a little bit about your project before you posted the rest of the images. -You describe how you toiled, sweated, _bled_ for your project, and then... you reveal its glory in the next row of images. - -
-
- {% include figure.liquid path="assets/img/6.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
- {% include figure.liquid path="assets/img/11.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
-
- You can also have artistically styled 2/3 + 1/3 images, like these. -
- -The code is simple. -Just wrap your images with `
` and place them inside `
` (read more about the Bootstrap Grid system). -To make images responsive, add `img-fluid` class to each; for rounded corners and shadows use `rounded` and `z-depth-1` classes. -Here's the code for the last row of images above: - -{% raw %} - -```html -
-
- {% include figure.liquid path="assets/img/6.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
- {% include figure.liquid path="assets/img/11.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
-``` - -{% endraw %} diff --git a/_projects/9_project.md b/_projects/9_project.md deleted file mode 100644 index 7345bbb..0000000 --- a/_projects/9_project.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -layout: page -title: project 9 -description: another project with an image 🎉 -img: assets/img/6.jpg -importance: 4 -category: fun ---- - -Every project has a beautiful feature showcase page. -It's easy to include images in a flexible 3-column grid format. -Make your photos 1/3, 2/3, or full width. - -To give your project a background in the portfolio page, just add the img tag to the front matter like so: - - --- - layout: page - title: project - description: a project with a background image - img: /assets/img/12.jpg - --- - -
-
- {% include figure.liquid loading="eager" path="assets/img/1.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
- {% include figure.liquid loading="eager" path="assets/img/3.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
- {% include figure.liquid loading="eager" path="assets/img/5.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
-
- Caption photos easily. On the left, a road goes through a tunnel. Middle, leaves artistically fall in a hipster photoshoot. Right, in another hipster photoshoot, a lumberjack grasps a handful of pine needles. -
-
-
- {% include figure.liquid loading="eager" path="assets/img/5.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
-
- This image can also have a caption. It's like magic. -
- -You can also put regular text between your rows of images. -Say you wanted to write a little bit about your project before you posted the rest of the images. -You describe how you toiled, sweated, _bled_ for your project, and then... you reveal its glory in the next row of images. - -
-
- {% include figure.liquid path="assets/img/6.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
- {% include figure.liquid path="assets/img/11.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
-
- You can also have artistically styled 2/3 + 1/3 images, like these. -
- -The code is simple. -Just wrap your images with `
` and place them inside `
` (read more about the Bootstrap Grid system). -To make images responsive, add `img-fluid` class to each; for rounded corners and shadows use `rounded` and `z-depth-1` classes. -Here's the code for the last row of images above: - -{% raw %} - -```html -
-
- {% include figure.liquid path="assets/img/6.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
- {% include figure.liquid path="assets/img/11.jpg" title="example image" class="img-fluid rounded z-depth-1" %} -
-
-``` - -{% endraw %} diff --git a/assets/audio/epicaly-short-113909.mp3 b/assets/audio/epicaly-short-113909.mp3 deleted file mode 100644 index 5fd64b9..0000000 Binary files a/assets/audio/epicaly-short-113909.mp3 and /dev/null differ diff --git a/assets/html/relativity.html b/assets/html/relativity.html deleted file mode 100644 index 7d3472a..0000000 --- a/assets/html/relativity.html +++ /dev/null @@ -1,10 +0,0 @@ - - -
-

Relativity: the Special and General Theory

-
Albert Einstein
-
- Insert HTML document here. -
- - diff --git a/assets/img/1.jpg b/assets/img/1.jpg deleted file mode 100644 index 1f2eb4c..0000000 Binary files a/assets/img/1.jpg and /dev/null differ diff --git a/assets/img/10.jpg b/assets/img/10.jpg deleted file mode 100644 index e9958d4..0000000 Binary files a/assets/img/10.jpg and /dev/null differ diff --git a/assets/img/11.jpg b/assets/img/11.jpg deleted file mode 100644 index 9db0d27..0000000 Binary files a/assets/img/11.jpg and /dev/null differ diff --git a/assets/img/12.jpg b/assets/img/12.jpg deleted file mode 100644 index e343b39..0000000 Binary files a/assets/img/12.jpg and /dev/null differ diff --git a/assets/img/2.jpg b/assets/img/2.jpg deleted file mode 100644 index 4f663e8..0000000 Binary files a/assets/img/2.jpg and /dev/null differ diff --git a/assets/img/3.jpg b/assets/img/3.jpg deleted file mode 100644 index 2cc28bd..0000000 Binary files a/assets/img/3.jpg and /dev/null differ diff --git a/assets/img/4.jpg b/assets/img/4.jpg deleted file mode 100644 index 746b206..0000000 Binary files a/assets/img/4.jpg and /dev/null differ diff --git a/assets/img/5.jpg b/assets/img/5.jpg deleted file mode 100644 index 80a4df3..0000000 Binary files a/assets/img/5.jpg and /dev/null differ diff --git a/assets/img/6.jpg b/assets/img/6.jpg deleted file mode 100644 index 92317be..0000000 Binary files a/assets/img/6.jpg and /dev/null differ diff --git a/assets/img/7.jpg b/assets/img/7.jpg deleted file mode 100644 index f581ccd..0000000 Binary files a/assets/img/7.jpg and /dev/null differ diff --git a/assets/img/8.jpg b/assets/img/8.jpg deleted file mode 100644 index 498432a..0000000 Binary files a/assets/img/8.jpg and /dev/null differ diff --git a/assets/img/9.jpg b/assets/img/9.jpg deleted file mode 100644 index d5b7972..0000000 Binary files a/assets/img/9.jpg and /dev/null differ diff --git a/assets/img/book_covers/the_godfather.jpg b/assets/img/book_covers/the_godfather.jpg deleted file mode 100644 index 1d3a085..0000000 Binary files a/assets/img/book_covers/the_godfather.jpg and /dev/null differ diff --git a/assets/img/prof_pic.jpg b/assets/img/prof_pic.jpg deleted file mode 100644 index 46bcf9c..0000000 Binary files a/assets/img/prof_pic.jpg and /dev/null differ diff --git a/assets/img/prof_pic_color.png b/assets/img/prof_pic_color.png deleted file mode 100644 index 4a33911..0000000 Binary files a/assets/img/prof_pic_color.png and /dev/null differ diff --git a/assets/img/rhino.png b/assets/img/rhino.png deleted file mode 100644 index ed8bdfc..0000000 Binary files a/assets/img/rhino.png and /dev/null differ diff --git a/assets/json/table_data.json b/assets/json/table_data.json deleted file mode 100644 index a44a088..0000000 --- a/assets/json/table_data.json +++ /dev/null @@ -1,128 +0,0 @@ -[ - { - "id": 0, - "name": "Item 0", - "price": "$0", - "amount": 3 - }, - { - "id": 1, - "name": "Item 1", - "price": "$1", - "amount": 4 - }, - { - "id": 2, - "name": "Item 2", - "price": "$2", - "amount": 8 - }, - { - "id": 3, - "name": "Item 3", - "price": "$3", - "amount": 2 - }, - { - "id": 4, - "name": "Item 4", - "price": "$4", - "amount": 90 - }, - { - "id": 5, - "name": "Item 5", - "price": "$5", - "amount": 2 - }, - { - "id": 6, - "name": "Item 6", - "price": "$6", - "amount": 3 - }, - { - "id": 7, - "name": "Item 7", - "price": "$7", - "amount": 7 - }, - { - "id": 8, - "name": "Item 8", - "price": "$8", - "amount": 39 - }, - { - "id": 9, - "name": "Item 9", - "price": "$9", - "amount": 78 - }, - { - "id": 10, - "name": "Item 10", - "price": "$10", - "amount": 30 - }, - { - "id": 11, - "name": "Item 11", - "price": "$11", - "amount": 32 - }, - { - "id": 12, - "name": "Item 12", - "price": "$12", - "amount": 12 - }, - { - "id": 13, - "name": "Item 13", - "price": "$13", - "amount": 76 - }, - { - "id": 14, - "name": "Item 14", - "price": "$14", - "amount": 10 - }, - { - "id": 15, - "name": "Item 15", - "price": "$15", - "amount": 9 - }, - { - "id": 16, - "name": "Item 16", - "price": "$16", - "amount": 8 - }, - { - "id": 17, - "name": "Item 17", - "price": "$17", - "amount": 1 - }, - { - "id": 18, - "name": "Item 18", - "price": "$18", - "amount": 99 - }, - { - "id": 19, - "name": "Item 19", - "price": "$19", - "amount": 100 - }, - { - "id": 20, - "name": "Item 20", - "price": "$20", - "amount": 109 - } -] diff --git a/assets/jupyter/blog.ipynb b/assets/jupyter/blog.ipynb deleted file mode 100755 index bc870dc..0000000 --- a/assets/jupyter/blog.ipynb +++ /dev/null @@ -1,48 +0,0 @@ -{ - "cells": [ - { - "cell_type": "code", - "execution_count": 1, - "metadata": { - "collapsed": false - }, - "outputs": [ - { - "data": { - "text/plain": [ - "sys.version_info(major=3, minor=6, micro=2, releaselevel='final', serial=0)" - ] - }, - "execution_count": 1, - "metadata": {}, - "output_type": "execute_result" - } - ], - "source": [ - "import sys\n", - "sys.version_info" - ] - } - ], - "metadata": { - "kernelspec": { - "display_name": "Python 3", - "language": "python", - "name": "python3" - }, - "language_info": { - "codemirror_mode": { - "name": "ipython", - "version": 3 - }, - "file_extension": ".py", - "mimetype": "text/x-python", - "name": "python", - "nbconvert_exporter": "python", - "pygments_lexer": "ipython3", - "version": "3.6.2" - } - }, - "nbformat": 4, - "nbformat_minor": 2 -} diff --git a/assets/pdf/example_pdf.pdf b/assets/pdf/example_pdf.pdf deleted file mode 100644 index b1f80db..0000000 Binary files a/assets/pdf/example_pdf.pdf and /dev/null differ diff --git a/assets/plotly/demo.html b/assets/plotly/demo.html deleted file mode 100644 index b78329e..0000000 --- a/assets/plotly/demo.html +++ /dev/null @@ -1,71 +0,0 @@ - - - -
-
- - \ No newline at end of file diff --git a/assets/video/pexels-engin-akyurt-6069112-960x540-30fps.mp4 b/assets/video/pexels-engin-akyurt-6069112-960x540-30fps.mp4 deleted file mode 100644 index c4c55d7..0000000 Binary files a/assets/video/pexels-engin-akyurt-6069112-960x540-30fps.mp4 and /dev/null differ diff --git a/assets/video/tutorial_al_folio.mp4 b/assets/video/tutorial_al_folio.mp4 deleted file mode 100644 index 5774ab2..0000000 Binary files a/assets/video/tutorial_al_folio.mp4 and /dev/null differ diff --git a/docker-compose-slim.yml b/docker-compose-slim.yml deleted file mode 100644 index 3bd4f46..0000000 --- a/docker-compose-slim.yml +++ /dev/null @@ -1,12 +0,0 @@ -# this file uses prebuilt image in dockerhub -services: - jekyll: - image: amirpourmand/al-folio:slim - #build: . - ports: - - 8080:8080 - - 35729:35729 - volumes: - - .:/srv/jekyll - environment: - - JEKYLL_ENV=development diff --git a/docker-compose.yml b/docker-compose.yml deleted file mode 100644 index d1dbb46..0000000 --- a/docker-compose.yml +++ /dev/null @@ -1,21 +0,0 @@ -# this file uses prebuilt image in dockerhub -services: - jekyll: - image: amirpourmand/al-folio:v0.14.6 - build: . - # uncomment these if you are having this issue with the build: - # /usr/local/bundle/gems/jekyll-4.3.4/lib/jekyll/site.rb:509:in `initialize': Permission denied @ rb_sysopen - /srv/jekyll/.jekyll-cache/.gitignore (Errno::EACCES) - # and fill the args values with the output of the commands on the right - # build: - # args: - # GROUPID: # id -g - # GROUPNAME: # id -gn - # USERID: # id -u - # USERNAME: # echo $USER - ports: - - 8080:8080 - - 35729:35729 - volumes: - - .:/srv/jekyll - environment: - - JEKYLL_ENV=development diff --git a/readme_preview/al-folio-preview.png b/readme_preview/al-folio-preview.png deleted file mode 100644 index e9acedb..0000000 Binary files a/readme_preview/al-folio-preview.png and /dev/null differ diff --git a/readme_preview/blog.png b/readme_preview/blog.png deleted file mode 100644 index 0f36828..0000000 Binary files a/readme_preview/blog.png and /dev/null differ diff --git a/readme_preview/code.png b/readme_preview/code.png deleted file mode 100644 index 6dd6f84..0000000 Binary files a/readme_preview/code.png and /dev/null differ diff --git a/readme_preview/cv.png b/readme_preview/cv.png deleted file mode 100644 index b92c9f0..0000000 Binary files a/readme_preview/cv.png and /dev/null differ diff --git a/readme_preview/dark.png b/readme_preview/dark.png deleted file mode 100644 index 311479c..0000000 Binary files a/readme_preview/dark.png and /dev/null differ diff --git a/readme_preview/distill.png b/readme_preview/distill.png deleted file mode 100644 index 99d7847..0000000 Binary files a/readme_preview/distill.png and /dev/null differ diff --git a/readme_preview/jupyter.png b/readme_preview/jupyter.png deleted file mode 100644 index 8890918..0000000 Binary files a/readme_preview/jupyter.png and /dev/null differ diff --git a/readme_preview/light.png b/readme_preview/light.png deleted file mode 100644 index 985686a..0000000 Binary files a/readme_preview/light.png and /dev/null differ diff --git a/readme_preview/math.png b/readme_preview/math.png deleted file mode 100644 index 7f41e3e..0000000 Binary files a/readme_preview/math.png and /dev/null differ diff --git a/readme_preview/people.png b/readme_preview/people.png deleted file mode 100644 index 3e3687c..0000000 Binary files a/readme_preview/people.png and /dev/null differ diff --git a/readme_preview/photos-screenshot.png b/readme_preview/photos-screenshot.png deleted file mode 100644 index 3dce0a1..0000000 Binary files a/readme_preview/photos-screenshot.png and /dev/null differ diff --git a/readme_preview/projects.png b/readme_preview/projects.png deleted file mode 100644 index 375a898..0000000 Binary files a/readme_preview/projects.png and /dev/null differ diff --git a/readme_preview/publications.png b/readme_preview/publications.png deleted file mode 100644 index f1d0068..0000000 Binary files a/readme_preview/publications.png and /dev/null differ diff --git a/readme_preview/repositories.png b/readme_preview/repositories.png deleted file mode 100644 index e1a7ac9..0000000 Binary files a/readme_preview/repositories.png and /dev/null differ diff --git a/robots.txt b/robots.txt deleted file mode 100644 index a450fbe..0000000 --- a/robots.txt +++ /dev/null @@ -1,7 +0,0 @@ ---- -permalink: /robots.txt ---- -User-agent: * -Disallow: - -Sitemap: {{ site.baseurl | prepend: site.url }}/sitemap.xml