diff --git a/.all-contributorsrc b/.all-contributorsrc deleted file mode 100644 index 99b43da..0000000 --- a/.all-contributorsrc +++ /dev/null @@ -1,44 +0,0 @@ -{ - "files": ["README.md"], - "imageSize": 100, - "commit": false, - "contributorsPerLine": 7, - "projectName": "al-folio", - "projectOwner": "alshedivat", - "repoType": "github", - "repoHost": "https://github.com", - "badgeTemplate": "[core_contributors]: https://img.shields.io/badge/core_contributors-<%= contributors.length %>-orange.svg 'Number of core contributors'", - "contributorTemplate": "\">\" width=\"<%= options.imageSize %>px;\" alt=\"\"/>
<%= contributor.name %>", - "skipCi": true, - "contributors": [ - { - "login": "alshedivat", - "name": "Maruan", - "avatar_url": "https://avatars.githubusercontent.com/u/2126561?v=4", - "profile": "http://maruan.alshedivat.com", - "contributions": ["design", "code"] - }, - { - "login": "rohandebsarkar", - "name": "Rohan Deb Sarkar", - "avatar_url": "https://avatars.githubusercontent.com/u/50144004?v=4", - "profile": "http://rohandebsarkar.github.io", - "contributions": ["code"] - }, - { - "login": "pourmand1376", - "name": "Amir Pourmand", - "avatar_url": "https://avatars.githubusercontent.com/u/32064808?v=4", - "profile": "https://amirpourmand.ir", - "contributions": ["code"] - }, - { - "login": "george-gca", - "name": "George", - "avatar_url": "https://avatars.githubusercontent.com/u/31376482?v=4", - "profile": "https://george-gca.github.io/", - "contributions": ["code"] - } - ], - "commitConvention": "angular" -} diff --git a/.github/release.yml b/.github/release.yml deleted file mode 100644 index 4fdc27e..0000000 --- a/.github/release.yml +++ /dev/null @@ -1,14 +0,0 @@ -changelog: - exclude: - labels: - - ignore-for-release - categories: - - title: new features πŸš€ - labels: - - enhancement - - title: bug fixes and improvements ✨ - labels: - - bug-fix - - title: other changes πŸ› οΈ - labels: - - "*" diff --git a/.github/stale.yml b/.github/stale.yml deleted file mode 100644 index 8ec2004..0000000 --- a/.github/stale.yml +++ /dev/null @@ -1,18 +0,0 @@ -# Number of days of inactivity before an issue becomes stale -daysUntilStale: 60 -# Number of days of inactivity before a stale issue is closed -daysUntilClose: 7 -# Issues with these labels will never be considered stale -exemptLabels: - - pinned - - security - - enhancement -# Label to use when marking an issue as stale -staleLabel: wontfix -# Comment to post when marking an issue as stale. Set to `false` to disable -markComment: > - This issue has been automatically marked as stale because it has not had - recent activity. It will be closed if no further activity occurs. Thank you - for your contributions. -# Comment to post when closing a stale issue. Set to `false` to disable -closeComment: false diff --git a/.github/workflows/axe.yml b/.github/workflows/axe.yml deleted file mode 100644 index afa3c92..0000000 --- a/.github/workflows/axe.yml +++ /dev/null @@ -1,74 +0,0 @@ -name: Axe accessibility testing - -on: - # if you want to run this on every push uncomment the following lines - # push: - # branches: - # - master - # - main - # pull_request: - # branches: - # - master - # - main - workflow_dispatch: - inputs: - url: - description: "URL to be checked (e.g.: blog/)" - required: false - -env: - URL: "" - -jobs: - check: - # available images: https://github.com/actions/runner-images#available-images - runs-on: ubuntu-latest - steps: - - name: Checkout πŸ›ŽοΈ - uses: actions/checkout@v4 - - name: Setup Ruby - uses: ruby/setup-ruby@v1 - with: - ruby-version: "3.2.2" - bundler-cache: true - - name: Update _config.yml βš™οΈ - uses: fjogeleit/yaml-update-action@main - with: - commitChange: false - valueFile: "_config.yml" - changes: | - { - "giscus.repo": "${{ github.repository }}", - "baseurl": "" - } - - name: Install and Build πŸ”§ - run: | - sudo apt-get update && sudo apt-get install -y imagemagick - pip3 install --upgrade jupyter - export JEKYLL_ENV=production - bundle exec jekyll build - - name: Purge unused CSS 🧹 - run: | - npm install -g purgecss - purgecss -c purgecss.config.js - - name: Get Chromium version 🌐 - # https://github.com/GoogleChromeLabs/chrome-for-testing?tab=readme-ov-file#other-api-endpoints - run: | - CHROMIUM_VERSION=$(wget -qO- https://googlechromelabs.github.io/chrome-for-testing/LATEST_RELEASE_STABLE | cut -d. -f1) - echo "Chromium version: $CHROMIUM_VERSION" - echo "CHROMIUM_VERSION=$CHROMIUM_VERSION" >> $GITHUB_ENV - - name: Setup Chrome 🌐 - id: setup-chrome - uses: browser-actions/setup-chrome@v1 - with: - chrome-version: ${{ env.CHROMIUM_VERSION }} - - name: Install chromedriver πŸš— - run: | - npm install -g chromedriver@$CHROMIUM_VERSION - - name: Run axe πŸͺ“ - # https://github.com/dequelabs/axe-core-npm/tree/develop/packages/cli - run: | - npm install -g @axe-core/cli - npm install -g http-server - http-server _site/ & - axe --chromedriver-path $(npm root -g)/chromedriver/bin/chromedriver http://localhost:8080/${{ github.event.inputs.url || env.URL }} --load-delay=1500 --exit diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml index d09a3b5..83ff659 100644 --- a/.github/workflows/codeql.yml +++ b/.github/workflows/codeql.yml @@ -61,7 +61,7 @@ jobs: # Initializes the CodeQL tools for scanning. - name: Initialize CodeQL - uses: github/codeql-action/init@v3 + uses: github/codeql-action/init@v4 with: languages: ${{ matrix.language }} build-mode: ${{ matrix.build-mode }} @@ -89,6 +89,6 @@ jobs: exit 1 - name: Perform CodeQL Analysis - uses: github/codeql-action/analyze@v3 + uses: github/codeql-action/analyze@v4 with: category: "/language:${{matrix.language}}" diff --git a/.github/workflows/deploy-docker-tag.yml b/.github/workflows/deploy-docker-tag.yml deleted file mode 100644 index d7710e2..0000000 --- a/.github/workflows/deploy-docker-tag.yml +++ /dev/null @@ -1,50 +0,0 @@ -name: Docker Image CI (Upload Tag) - -on: - push: - tags: - - "v*" - paths: - - ".github/workflows/deploy-docker-tag.yml" - - ".github/workflows/deploy-image.yml" - - "bin/entry_point.sh" - - "Dockerfile" - - "Gemfile" - - "Gemfile.lock" - - "package.json" - - "package-lock.json" - -jobs: - build: - runs-on: ubuntu-latest - - steps: - - name: Checkout - uses: actions/checkout@v4 - - - name: Set up QEMU - uses: docker/setup-qemu-action@v3 - - - name: Buildx - uses: docker/setup-buildx-action@v3 - - - name: Docker meta - id: meta - uses: docker/metadata-action@v5 - with: - images: amirpourmand/al-folio - - - name: Login - uses: docker/login-action@v3 - with: - username: ${{ secrets.DOCKER_USERNAME }} - password: ${{ secrets.DOCKER_PASSWORD }} - - - name: Build and push - uses: docker/build-push-action@v5 - with: - context: . - platforms: linux/amd64,linux/arm64/v8 - push: ${{ github.event_name != 'pull_request' }} - tags: ${{ steps.meta.outputs.tags }} - labels: ${{ steps.meta.outputs.labels }} diff --git a/.github/workflows/deploy-image.yml b/.github/workflows/deploy-image.yml deleted file mode 100644 index 7ddd8f6..0000000 --- a/.github/workflows/deploy-image.yml +++ /dev/null @@ -1,44 +0,0 @@ -name: Docker Image CI - -on: - push: - branches: - - master - - main - paths: - - ".github/workflows/deploy-image.yml" - - "bin/entry_point.sh" - - "Dockerfile" - - "Gemfile" - - "Gemfile.lock" - - "package.json" - - "package-lock.json" - -jobs: - build: - runs-on: ubuntu-latest - if: github.repository_owner == 'alshedivat' - - steps: - - name: Checkout - uses: actions/checkout@v4 - - - name: Set up QEMU - uses: docker/setup-qemu-action@v3 - - - name: Buildx - uses: docker/setup-buildx-action@v3 - - - name: Login - uses: docker/login-action@v3 - with: - username: ${{ secrets.DOCKER_USERNAME }} - password: ${{ secrets.DOCKER_PASSWORD }} - - - name: Build and push - uses: docker/build-push-action@v5 - with: - context: . - push: true - platforms: linux/amd64,linux/arm64/v8 - tags: amirpourmand/al-folio diff --git a/.github/workflows/docker-slim.yml b/.github/workflows/docker-slim.yml deleted file mode 100644 index 3a67d32..0000000 --- a/.github/workflows/docker-slim.yml +++ /dev/null @@ -1,57 +0,0 @@ -name: Docker Slim - -#Only trigger, when the build workflow succeeded -on: - push: - branches: - - master - - main - paths: - - ".github/workflows/docker-slim.yml" - workflow_run: - workflows: ["Docker Image CI"] - types: - - completed - -# on: -# push: -# branches: -# - 'master' - -jobs: - build: - # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#running-a-workflow-based-on-the-conclusion-of-another-workflow - if: ${{ github.event.workflow_run.conclusion == 'success' && github.repository_owner == 'alshedivat' }} - runs-on: ubuntu-latest - defaults: - run: - working-directory: ${{ github.workspace }} - - steps: - - name: Checkout - uses: actions/checkout@v4 - - - name: Login - uses: docker/login-action@v3 - with: - username: ${{ secrets.DOCKER_USERNAME }} - password: ${{ secrets.DOCKER_PASSWORD }} - - - name: update docker-compose - shell: bash - run: | - sed -i "s|\.:|${{ github.workspace }}:|g" ${{ github.workspace }}/docker-compose.yml - cat ${{ github.workspace }}/docker-compose.yml - - - uses: kitabisa/docker-slim-action@v1.1.1 - env: - DSLIM_PULL: true - DSLIM_COMPOSE_FILE: ${{ github.workspace }}/docker-compose.yml - DSLIM_TARGET_COMPOSE_SVC: jekyll - DSLIM_CONTINUE_AFTER: signal - with: - target: amirpourmand/al-folio - tag: "slim" - - # Push to the registry - - run: docker image push amirpourmand/al-folio:slim diff --git a/.github/workflows/lighthouse-badger.yml b/.github/workflows/lighthouse-badger.yml deleted file mode 100644 index addec2d..0000000 --- a/.github/workflows/lighthouse-badger.yml +++ /dev/null @@ -1,62 +0,0 @@ -# Lighthouse-Badger-Easy | GitHub Action Workflow -# -# Description: Generates, adds & updates manually/automatically Lighthouse badges & reports from one/multiple input URL(s) to the current repository & main branch with minimal settings -# Author: Sitdisch -# Source: https://github.com/myactionway/lighthouse-badger-workflows -# License: MIT -# Copyright (c) 2021 Sitdisch - -name: "Lighthouse Badger" - -######################################################################## -# DEFINE YOUR INPUTS AND TRIGGERS IN THE FOLLOWING -######################################################################## - -# INPUTS as Secrets (env) for not manually triggered workflows -env: - URLS: https://alshedivat.github.io/al-folio/ - # If any of the following env is blank, a default value is used instead - REPO_BRANCH: "${{ github.repository }} master" # target repository & branch e.g. 'dummy/mytargetrepo main' - MOBILE_LIGHTHOUSE_PARAMS: "--only-categories=performance,accessibility,best-practices,seo --throttling.cpuSlowdownMultiplier=2" - DESKTOP_LIGHTHOUSE_PARAMS: "--only-categories=performance,accessibility,best-practices,seo --preset=desktop --throttling.cpuSlowdownMultiplier=1" - -# TRIGGERS -on: - page_build: - # schedule: # Check your schedule here => https://crontab.guru/ - # - cron: '55 23 * * 0' # e.g. every Sunday at 23:55 - # - # THAT'S IT; YOU'RE DONE; - workflow_dispatch: - -######################################################################## -# THAT'S IT; YOU DON'T HAVE TO DEFINE ANYTHING IN THE FOLLOWING -######################################################################## - -jobs: - lighthouse-badger-easy: - runs-on: ubuntu-latest - timeout-minutes: 8 - steps: - - name: Preparatory Tasks - run: | - REPOSITORY=`expr "${{ env.REPO_BRANCH }}" : "\([^ ]*\)"` - BRANCH=`expr "${{ env.REPO_BRANCH }}" : ".* \([^ ]*\)"` - echo "REPOSITORY=$REPOSITORY" >> $GITHUB_ENV - echo "BRANCH=$BRANCH" >> $GITHUB_ENV - env: - REPO_BRANCH: ${{ env.REPO_BRANCH }} - - uses: actions/checkout@v4 - with: - repository: ${{ env.REPOSITORY }} - token: ${{ secrets.LIGHTHOUSE_BADGER_TOKEN }} - ref: ${{ env.BRANCH }} - - uses: actions/checkout@v4 - with: - repository: "myactionway/lighthouse-badges" - path: temp_lighthouse_badges_nested - - uses: myactionway/lighthouse-badger-action@v2.2 - with: - urls: ${{ env.URLS }} - mobile_lighthouse_params: ${{ env.MOBILE_LIGHTHOUSE_PARAMS }} - desktop_lighthouse_params: ${{ env.DESKTOP_LIGHTHOUSE_PARAMS }} diff --git a/.github/workflows/prettier-comment-on-pr.yml b/.github/workflows/prettier-comment-on-pr.yml deleted file mode 100644 index e95075c..0000000 --- a/.github/workflows/prettier-comment-on-pr.yml +++ /dev/null @@ -1,18 +0,0 @@ -name: Comment on pull request - -on: - repository_dispatch: - types: [prettier-failed-on-pr] - -jobs: - comment: - # available images: https://github.com/actions/runner-images#available-images - runs-on: ubuntu-latest - steps: - - name: PR comment with html diff πŸ’¬ - uses: thollander/actions-comment-pull-request@v2 - with: - comment_tag: prettier-failed - pr_number: ${{ github.event.client_payload.pr_number }} - message: | - Failed [prettier code check](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.event.client_payload.run_id }}). Check [this file](${{ github.event.client_payload.artifact_url }}) for more information. diff --git a/.prettierignore b/.prettierignore index b276dd9..11c7776 100644 --- a/.prettierignore +++ b/.prettierignore @@ -3,6 +3,7 @@ **/*.min.js assets/css/main.scss assets/js/distillpub/template.v2.js +assets/js/distillpub/transforms.v2.js assets/js/search/*.js assets/plotly/demo.html lighthouse_results/** 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/CUSTOMIZE.md b/CUSTOMIZE.md deleted file mode 100644 index 6c4f3ab..0000000 --- a/CUSTOMIZE.md +++ /dev/null @@ -1,347 +0,0 @@ -# Customize - -Here we will give you some tips on how to customize the website. One important thing to note is that **ALL** the changes you make should be done on the **main** branch of your repository. The `gh-pages` branch is automatically overwritten every time you make a change to the main branch. - - - -- [Customize](#customize) - - [Project structure](#project-structure) - - [Configuration](#configuration) - - [Modifying the CV information](#modifying-the-cv-information) - - [Modifying the user and repository information](#modifying-the-user-and-repository-information) - - [Creating new pages](#creating-new-pages) - - [Creating new blog posts](#creating-new-blog-posts) - - [Creating new projects](#creating-new-projects) - - [Adding some news](#adding-some-news) - - [Adding Collections](#adding-collections) - - [Adding a new publication](#adding-a-new-publication) - - [Author annotation](#author-annotation) - - [Buttons (through custom bibtex keywords)](#buttons-through-custom-bibtex-keywords) - - [Changing theme color](#changing-theme-color) - - [Adding social media information](#adding-social-media-information) - - [Adding a newsletter](#adding-a-newsletter) - - [Removing content](#removing-content) - - [Removing the blog page](#removing-the-blog-page) - - [Removing the news section](#removing-the-news-section) - - [Removing the projects page](#removing-the-projects-page) - - [Removing the publications page](#removing-the-publications-page) - - [Removing the repositories page](#removing-the-repositories-page) - - [You can also remove pages through commenting out front-matter blocks](#you-can-also-remove-pages-through-commenting-out-front-matter-blocks) - - [Adding Token for Lighthouse Badger](#adding-token-for-lighthouse-badger) - - [Personal Access Token (fine-grained) Permissions for Lighthouse Badger:](#personal-access-token-fine-grained-permissions-for-lighthouse-badger) - - [Customizing fonts, spacing, and more](#customizing-fonts-spacing-and-more) - - [Scheduled Posts](#scheduled-posts) - - [Name Format](#name-format) - - [Important Notes](#important-notes) - - - -## Project structure - -The project is structured as follows, focusing on the main components that you will need to modify: - -```txt -. -β”œβ”€β”€ πŸ“‚ assets/: contains the assets that are displayed in the website -β”‚Β Β  └── πŸ“‚ json/ - β”‚Β Β  └── πŸ“„ resume.json: CV in JSON format (https://jsonresume.org/) -β”œβ”€β”€ πŸ“‚ _bibliography/ -β”‚Β Β  └── πŸ“„ papers.bib: bibliography in BibTeX format -β”œβ”€β”€ πŸ“‚ _books/: contains the bookshelf pages -β”œβ”€β”€ πŸ“„ _config.yml: the configuration file of the template -β”œβ”€β”€ πŸ“‚ _data/: contains some of the data used in the template -β”‚Β Β  β”œβ”€β”€ πŸ“„ cv.yml: CV in YAML format, used when assets/json/resume.json is not found -β”‚Β Β  β”œβ”€β”€ πŸ“„ repositories.yml: users and repositories info in YAML format -β”‚Β Β  └── πŸ“„ socials.yml: your social media and contact info in YAML format -β”œβ”€β”€ πŸ“‚ _includes/: contains code parts that are included in the main HTML file -β”‚Β Β  └── πŸ“„ news.liquid: defines the news section layout in the about page -β”œβ”€β”€ πŸ“‚ _layouts/: contains the layouts to choose from in the frontmatter of the Markdown files -β”œβ”€β”€ πŸ“‚ _news/: the news that will appear in the news section in the about page -β”œβ”€β”€ πŸ“‚ _pages/: contains the pages of the website -| └── πŸ“„ 404.md: 404 page (page not found) -β”œβ”€β”€ πŸ“‚ _posts/: contains the blog posts -β”œβ”€β”€ πŸ“‚ _projects/: contains the projects -└── πŸ“‚ _sass/: contains the SASS files that define the style of the website - β”œβ”€β”€ πŸ“„ _base.scss: base style of the website - β”œβ”€β”€ πŸ“„ _cv.scss: style of the CV page - β”œβ”€β”€ πŸ“„ _distill.scss: style of the Distill articles - β”œβ”€β”€ πŸ“„ _layout.scss: style of the overall layout - β”œβ”€β”€ πŸ“„ _themes.scss: themes colors and a few icons - └── πŸ“„ _variables.scss: variables used in the SASS files -``` - -## Configuration - -The configuration file [\_config.yml](_config.yml) contains the main configuration of the website. Most of the settings is self-explanatory and we also tried to add as much comments as possible. If you have any questions, please check if it was not already answered in the [FAQ](FAQ.md). - -> Note that the `url` and `baseurl` settings are used to generate the links of the website, as explained in the [install instructions](INSTALL.md). - -All changes made to this file are only visible after you rebuild the website. That means that you need to run `bundle exec jekyll serve` again if you are running the website locally or push your changes to GitHub if you are using GitHub Pages. All other changes are visible immediately, you only need to refresh the page. - -## Modifying the CV information - -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). If you want to use the [\_data/cv.yml](_data/cv.yml) file as the source of your CV, you must delete the [assets/json/resume.json](assets/json/resume.json) file. - -## Modifying the user and repository information - -The user and repository information is defined in [\_data/repositories.yml](_data/repositories.yml). You can add as many users and repositories as you want. Both informations are used in the `repositories` section. - -## Creating new pages - -You can create new pages by adding new Markdown files in the [\_pages](_pages/) directory. The easiest way to do this is to copy an existing page and modify it. You can choose the layout of the page by changing the [layout](https://jekyllrb.com/docs/layouts/) attribute in the [frontmatter](https://jekyllrb.com/docs/front-matter/) of the Markdown file, and also the path to access it by changing the [permalink](https://jekyllrb.com/docs/permalinks/) attribute. You can also add new layouts in the [\_layouts](_layouts/) directory if you feel the need for it. - -## Creating new blog posts - -To create a new blog post, you can add a new Markdown file in the [\_posts](_posts/) directory, which is the [default location for posts in Jekyll](https://jekyllrb.com/docs/posts/). The [name of the file must follow](https://jekyllrb.com/docs/posts/#creating-posts) the format `YYYY-MM-DD-title.md`. The easiest way to do this is to copy an existing blog post and modify it. Note that some blog posts have optional fields in the [frontmatter](https://jekyllrb.com/docs/front-matter/) that are used to enable specific behaviors or functions. - -If you want to create blog posts that are not ready to be published, but you want to track it with git, you can create a [\_drafts](https://jekyllrb.com/docs/posts/#drafts) directory and store them there. - -Note that `posts` is also a collection, but it is a default collection created automatically by Jekyll. To access the posts, you can use the `site.posts` variable in your templates. - -## Creating new projects - -You can create new projects by adding new Markdown files in the [\_projects](_projects/) directory. The easiest way to do this is to copy an existing project and modify it. - -## Adding some news - -You can add news in the about page by adding new Markdown files in the [\_news](_news/) directory. There are currently two types of news: inline news and news with a link. News with a link take you to a new page while inline news are displayed directly in the about page. The easiest way to create yours is to copy an existing news and modify it. - -## Adding Collections - -This Jekyll theme implements [collections](https://jekyllrb.com/docs/collections/) to let you break up your work into categories. The theme comes with three default collections: `news`, `projects`, and `books`. Items from the `news` collection are automatically displayed on the home page, while items from the `projects` collection are displayed on a responsive grid on projects page and items from the `books` collection are displayed on its own `bookshelf` page inside `submenus`. - -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](_pages/projects.md). - -If you wish to create a collection with support for categories and tags, like the blog posts, you just need to add this collection to the `jekyll-archives` section of your [\_config.yml](_config.yml) file. You can check how this is done with the `books` collection. For more information about customizing the archives section or creating your own archives page, check the [jekyll-archives-v2 documentation](https://george-gca.github.io/jekyll-archives-v2/). - -To access the collections, you can use the `site.COLLECTION_NAME` variable in your templates. - -## Adding a new publication - -To add publications create a new entry in the [\_bibliography/papers.bib](_bibliography/papers.bib) file. You can find the BibTeX entry of a publication in Google Scholar by clicking on the quotation marks below the publication title, then clicking on "BibTeX", or also in the conference page itself. 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/pdfs/` 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`, `annotation`, `arxiv`, `bibtex_show`, `blog`, `code`, `dimensions`, `doi`, `eprint`, `html`, `isbn`, `pdf`, `pmid`, `poster`, `slides`, `supp`, `video`, and `website`. - -### Author annotation - -In publications, the author entry for yourself is identified by string array `scholar:last_name` and string array `scholar:first_name` in [\_config.yml](_config.yml). For example, if you have the following entry in your [\_config.yml](_config.yml): - -```yaml -scholar: - last_name: [Einstein] - first_name: [Albert, A.] -``` - -If the entry matches one form of the last names and the first names, it will be underlined. Keep meta-information about your co-authors in [\_data/coauthors.yml](_data/coauthors.yml) and Jekyll will insert links to their webpages automatically. The co-author data format is as follows, with the last names lower cased and without accents as the key: - -```yaml -"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 -``` - -If the entry matches one of the combinations of the last names and the first names, it will be highlighted and linked to the url provided. Note that the keys **MUST BE** lower cased and **MUST NOT** contain accents. This is because the keys are used to match the last names in the BibTeX entries, considering possible variations (see [related discussion](https://github.com/alshedivat/al-folio/discussions/2213)). - -### Buttons (through custom bibtex keywords) - -There are several custom bibtex keywords that you can use to affect how the entries are displayed on the webpage: - -- `abbr`: Adds an abbreviation to the left of the entry. You can add links to these by creating a venue.yaml-file in the \_data folder and adding entries that match. -- `abstract`: Adds an "Abs" button that expands a hidden text field when clicked to show the abstract text -- `altmetric`: Adds an [Altmetric](https://www.altmetric.com/) badge (Note: if DOI is provided just use `true`, otherwise only add the altmetric identifier here - the link is generated automatically) -- `annotation`: Adds a popover info message to the end of the author list that can potentially be used to clarify superscripts. HTML is allowed. -- `arxiv`: Adds a link to the Arxiv website (Note: only add the arxiv identifier here - the link is generated automatically) -- `bibtex_show`: Adds a "Bib" button that expands a hidden text field with the full bibliography entry -- `blog`: Adds a "Blog" button redirecting to the specified link -- `code`: Adds a "Code" button redirecting to the specified link -- `dimensions`: Adds a [Dimensions](https://www.dimensions.ai/) badge (Note: if DOI or PMID is provided just use `true`, otherwise only add the Dimensions' identifier here - the link is generated automatically) -- `html`: Inserts an "HTML" button redirecting to the user-specified link -- `pdf`: Adds a "PDF" button redirecting to a specified file (if a full link is not specified, the file will be assumed to be placed in the /assets/pdf/ directory) -- `poster`: Adds a "Poster" button redirecting to a specified file (if a full link is not specified, the file will be assumed to be placed in the /assets/pdf/ directory) -- `slides`: Adds a "Slides" button redirecting to a specified file (if a full link is not specified, the file will be assumed to be placed in the /assets/pdf/ directory) -- `supp`: Adds a "Supp" button to a specified file (if a full link is not specified, the file will be assumed to be placed in the /assets/pdf/ directory) -- `website`: Adds a "Website" button redirecting to the specified link - -You can implement your own buttons by editing the [\_layouts/bib.liquid](_layouts/bib.liquid) file. - -## Changing theme color - -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](_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. - -## Adding social media information - -You can add your social media links by adding the specified information in the [\_data/socials.yml](_data/socials.yml) file. This information will appear at the bottom of the `About` page and in the search results by default, but this could be changed to appear at the header of the page by setting `enable_navbar_social: true` and doesn't appear in the search by setting `socials_in_search: false`, both in [\_config.yml](_config.yml). - -## Adding a newsletter - -You can add a newsletter subscription form by adding the specified information at the `newsletter` section in the [\_config.yml](_config.yml) file. To set up a newsletter, you can use a service like [Loops.so](https://loops.so/), which is the current supported solution. Once you have set up your newsletter, you can add the form [endpoint](https://loops.so/docs/forms/custom-form) to the `endpoint` field in the `newsletter` section of the [\_config.yml](_config.yml) file. - -Depending on your specified footer behavior, the sign up form either will appear at the bottom of the `About` page and at the bottom of blogposts if `related_posts` are enabled, or in the footer at the bottom of each page. - -## Removing content - -Since this template have a lot of content, you may want to remove some of it. The easiest way to achieve this and avoid merge conflicts when updating your code (as [pointed by CheariX ](https://github.com/alshedivat/al-folio/pull/2933#issuecomment-2571271117)) is to add the unwanted files to the `exclude` section in your `_config.yml` file instead of actually deleting them, for example: - -```yml -exclude: - - _news/announcement_*.md - - _pages/blog.md - - _posts/ - - _projects/?_project.md - - assets/jupyter/blog.ipynb -``` - -Here is a list of the main components that you may want to delete, and how to do it. Don't forget if you delete a page to update the `nav_order` of the remaining pages. - -### Removing the blog page - -To remove the blog, you have to: - -- delete [\_posts](_posts/) directory -- delete blog page [\_pages/blog.md](_pages/blog.md) -- remove reference to blog page in our [\_pages/dropdown.md](_pages/dropdown.md) -- remove the `latest_posts` part in [\_pages/about.md](_pages/about.md) -- remove the `Blog` section in the [\_config.yml](_config.yml) file and the related parts, like the `jekyll-archives` - -You can also: - -- delete [\_includes/latest_posts.liquid](_includes/latest_posts.liquid) -- delete [\_includes/related_posts.liquid](_includes/related_posts.liquid) -- delete [\_layouts/archive.liquid](_layouts/archive.liquid) (unless you have a custom collection that uses it) -- delete [\_plugins/external-posts.rb](_plugins/external-posts.rb) -- remove the `jekyll-archives-v2` gem from the [Gemfile](Gemfile) and the `plugins` section in [\_config.yml](_config.yml) (unless you have a custom collection that uses it) -- remove the `classifier-reborn` gem from the [Gemfile](Gemfile) - -### Removing the news section - -To remove the news section, you can: - -- delete the [\_news](_news/) directory -- delete the file [\_includes/news.liquid](_includes/news.liquid) and the references to it in the [\_pages/about.md](_pages/about.md) -- remove the `announcements` part in [\_pages/about.md](_pages/about.md) -- remove the news part in the `Collections` section in the [\_config.yml](_config.yml) file - -### Removing the projects page - -To remove the projects, you can: - -- delete the [\_projects](_projects/) directory -- delete the projects page [\_pages/projects.md](_pages/projects.md) -- remove reference to projects page in our [\_pages/dropdown.md](_pages/dropdown.md) -- remove projects part in the `Collections` section in the [\_config.yml](_config.yml) file - -You can also: - -- delete [\_includes/projects_horizontal.liquid](_includes/projects_horizontal.liquid) -- delete [\_includes/projects.liquid](_includes/projects.liquid) - -### Removing the publications page - -To remove the publications, you can: - -- delete the [\_bibliography](_bibliography/) directory -- delete the publications page [\_pages/publications.md](_pages/publications.md) -- remove reference to publications page in our [\_pages/dropdown.md](_pages/dropdown.md) -- remove `Jekyll Scholar` section in the [\_config.yml](_config.yml) file - -You can also: - -- delete the [\_layouts/bib.liquid](_layouts/bib.liquid) file -- delete [\_includes/bib_search.liquid](_includes/bib_search.liquid) -- delete [\_includes/citation.liquid](_includes/citation.liquid) -- delete [\_includes/selected_papers.liquid](_includes/selected_papers.liquid) -- delete [\_plugins/google-scholar-citations.rb](_plugins/google-scholar-citations.rb) -- delete [\_plugins/hide-custom-bibtex.rb](_plugins/hide-custom-bibtex.rb) -- delete [\_plugins/inspirehep-citations.rb](_plugins/inspirehep-citations.rb) -- remove the `jekyll-scholar` gem from the [Gemfile](Gemfile) and the `plugins` section in [\_config.yml](_config.yml) - -### Removing the repositories page - -To remove the repositories, you can: - -- delete the repositories page [\_pages/repositories.md](_pages/repositories.md) -- delete [\_includes/repository/](_includes/repository/) directory - -### You can also remove pages through commenting out front-matter blocks - -For `.md` files in [\pages](pages/) directory, if you do not want to completely edit or delete them but save for later use, you can temporarily disable these variables. But be aware that Jekyll only recognizes front matter when it appears as uncommented. The layout, permalink, and other front-matter behavior are disabled for that file. - -For example, books.md do: - -```md - - -> What an astonishing thing a book is. It's a flat object made from a tree with flexible parts on which are imprinted lots of funny dark squiggles. But one glance at it and you're inside the mind of another person, maybe somebody dead for thousands of years. Across the millennia, an author is speaking clearly and silently inside your head, directly to you. Writing is perhaps the greatest of human inventions, binding together people who never knew each other, citizens of distant epochs. Books break the shackles of time. A book is proof that humans are capable of working magic. -> -> -- Carl Sagan, Cosmos, Part 11: The Persistence of Memory (1980) - -## Books that I am reading, have read, or will read -``` - -## Adding Token for Lighthouse Badger - -To add secrets for [lighthouse-badger](https://github.com/alshedivat/al-folio/actions/workflows/lighthouse-badger.yml), create a [personal access token (PAT)](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. The [lighthouse-badger documentation](https://github.com/MyActionWay/lighthouse-badger-workflows#lighthouse-badger-easyyml) specifies using an environment variable, but using it as a secret is more secure and appropriate for a PAT. - -Also In case you face the error: "Input required and not supplied: token" in the Lighthouse Badger action, this solution resolves it. - -### Personal Access Token (fine-grained) Permissions for Lighthouse Badger: - -- **contents**: access: read and write -- **metadata**: access: read-only - -Due to the necessary permissions (PAT and others mentioned above), it is recommended to use it as a secret rather than an environment variable. - -## Customizing fonts, spacing, and more - -You can customize the fonts, spacing, and more by editing [\_sass/\_base.scss](_sass/_base.scss). The easiest way to try in advance the changes is by using [chrome dev tools](https://developer.chrome.com/docs/devtools/css) or [firefox dev tools](https://firefox-source-docs.mozilla.org/devtools-user/). In there you can click in the element and find all the attributes that are set for that element and where are they. For more information on how to use this, check [chrome](https://developer.chrome.com/docs/devtools/css) and [firefox](https://firefox-source-docs.mozilla.org/devtools-user/page_inspector/how_to/examine_and_edit_css/index.html) how-tos, and [this tutorial](https://www.youtube.com/watch?v=l0sgiwJyEu4). - -## Scheduled Posts - -`al-folio` contains a workflow which automatically publishes all posts scheduled at a specific day, at the end of the day (23:30). By default the action is disabled, and to enable it you need to go to `.github/workflows/` and find the file called `schedule-posts.txt`. This is the workflow file. For GitHub to recognize it as one (or to enable the action), you need to rename it to `schedule-posts.yml`. - -In order to use this you need to save all of your "Completed" blog posts which are scheduled to be uploaded on a specific date, in a folder named `_scheduled/` in the root directory. - -> Incomplete posts should be saved in `_drafts/` - -### Name Format - -In this folder you need to store your file in the same format as you would in `_posts/` - -> Example file name: `2024-08-26-This file will be uploaded on 26 August.md` - -### Important Notes - -- The scheduler uploads posts everyday at πŸ•› 23:30 UTC -- It will only upload posts at 23:30 UTC of their respective scheduled days, It's not uploaded in 23:59 in case there are a lot of files as the scheduler must finish before 00:00 -- It will only upload files which follow the pattern `yyyy-mm-dd-title.md` - - This means that only markdown files will be posted - - It means that any markdown which do not follow this pattern will not be posted -- The scheduler works by moving posts from the `_scheduled/` directory to `_posts/`, it will not post to folders like `_projects/` or `_news/` -- The date in the name of the file is the day that file will be uploaded on - - `2024-08-27-file1.md` will not be posted before or after 27-August-2024 (Scheduler only works for posts scheduled on the present day) - - `2025-08-27-file2.md` will be posted exactly on 27-August-2025 - - `File3.md` will not be posted at all - - `2026-02-31-file4.md` is supposed to be posted on 31-February-2026, but there is no 31st in February hence this file will never be posted either 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/ORIGINAL_README.md b/ORIGINAL_README.md deleted file mode 100644 index 4a8d708..0000000 --- a/ORIGINAL_README.md +++ /dev/null @@ -1,495 +0,0 @@ -# al-folio - -
- -[![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/stargazers) -[![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/) - ---- - -### 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/) - -You can easily create your own collections, apps, short stories, courses, or whatever your creative work is. To do this, edit the collections in the [\_config.yml](_config.yml) file, create a corresponding folder, and create a landing page for your collection, similar to `_pages/projects.md`. - ---- - -### Layouts - -**al-folio** comes with stylish layouts for pages and blog posts. - -#### The iconic style of Distill - -The theme allows you to create blog posts in the [distill.pub](https://distill.pub/) style: - -[![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 %} -``` - ---- - -#### Theming - -A variety of beautiful theme colors have been selected for you to choose from. The default is purple, but you can quickly change it by editing the `--global-theme-color` variable in the `_sass/_themes.scss` file. Other color variables are listed there as well. The stock theme color options available can be found at [\_sass/\_variables.scss](_sass/_variables.scss). You can also add your own colors to this file assigning each a name for ease of use across the template. - ---- - -#### Social media previews - -**al-folio** supports preview images on social media. To enable this functionality you will need to set `serve_og_meta` to `true` in your [\_config.yml](_config.yml). Once you have done so, all your site's pages will include Open Graph data in the HTML head element. - -You will then need to configure what image to display in your site's social media previews. This can be configured on a per-page basis, by setting the `og_image` page variable. If for an individual page this variable is not set, then the theme will fall back to a site-wide `og_image` variable, configurable in your [\_config.yml](_config.yml). In both the page-specific and site-wide cases, the `og_image` variable needs to hold the URL for the image you wish to display in social media previews. - ---- - -#### Atom (RSS-like) Feed - -It generates an Atom (RSS-like) feed of your posts, useful for Atom and RSS readers. The feed is reachable simply by typing after your homepage `/feed.xml`. E.g. assuming your website mountpoint is the main folder, you can type `yourusername.github.io/feed.xml` - ---- - -#### Related posts - -By default, there will be a related posts section on the bottom of the blog posts. These are generated by selecting the `max_related` most recent posts that share at least `min_common_tags` tags with the current post. If you do not want to display related posts on a specific post, simply add `related_posts: false` to the front matter of the post. If you want to disable it for all posts, simply set `enabled` to false in the `related_blog_posts` section in [\_config.yml](_config.yml). - ---- - -#### Code quality checks - -Currently, we run some checks to ensure that the code quality and generated site are good. The checks are done using GitHub Actions and the following tools: - -- [Prettier](https://prettier.io/) - check if the formatting of the code follows the style guide -- [lychee](https://lychee.cli.rs/) - check for broken links -- [Axe](https://github.com/dequelabs/axe-core) (need to run manually) - do some accessibility testing - -We decided to keep `Axe` runs manual because fixing the issues are not straightforward and might be hard for people without web development knowledge. - -## FAQ - -For frequently asked questions, please refer to [FAQ.md](FAQ.md). - -## Contributing - -Contributions to al-folio are very welcome! Before you get started, please take a look at [the guidelines](CONTRIBUTING.md). - -If you would like to improve documentation or fix a minor inconsistency or bug, please feel free to send a PR directly to `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). - -Originally, **al-folio** was based on the [\*folio theme](https://github.com/bogoli/-folio) (published by [Lia Bogoev](https://liabogoev.com) and under the MIT license). Since then, it got a full re-write of the styles and many additional cool features. diff --git a/README.md b/README.md index e26d2fe..ca6977f 100644 --- a/README.md +++ b/README.md @@ -1 +1 @@ -Personal website template based on [`alshedivat/ai-folio`](https://github.com/alshedivat/al-folio) +Personal website template based on [`alshedivat/al-folio`](https://github.com/alshedivat/al-folio) diff --git a/_config.yml b/_config.yml index b83524e..95a8e8f 100644 --- a/_config.yml +++ b/_config.yml @@ -4,21 +4,21 @@ title: blank # the website title (if blank, full name will be used instead) first_name: Chris -middle_name: +middle_name: last_name: Liao contact_note: > I am best reached by email. Feel free to get in touch! description: > # the ">" symbol means to ignore newlines until "footer_text:" - A simple, whitespace theme for academics. Based on [*folio](https://github.com/bogoli/-folio) design. + Chris Liao is an economics PhD student at UC Berkeley studying technology, innovation, and organizations. footer_text: > Powered by Jekyll with al-folio theme. Hosted by GitHub Pages. -keywords: jekyll, jekyll-theme, academic-website, portfolio-website # add your own keywords or leave empty +keywords: Chris Liao, economics, UC Berkeley, technology, innovation, organizations, industrial organization, AI # add your own keywords or leave empty lang: en # the language of your site (for example: en, fr, cn, ru, etc.) icon: βš›οΈ # the emoji used as the favicon (alternatively, provide image name in /assets/img/) url: https://liaochris.github.io # the base hostname & protocol for your site -baseurl: +baseurl: last_updated: false # set to true if you want to display last updated in the footer impressum_path: # set to path to include impressum link in the footer, use the same path as permalink in a page, helps to conform with EU GDPR back_to_top: true # set to false to disable the back to top button diff --git a/_data/socials.yml b/_data/socials.yml index b6455b8..1f0d04a 100644 --- a/_data/socials.yml +++ b/_data/socials.yml @@ -10,7 +10,7 @@ # bluesky_url: # your bluesky URL # dblp_url: # your DBLP profile url # discord_id: # your discord id (18-digit unique numerical identifier) -email: chrisliao@uchicago.edu # your email address +email: chrisliao@berkeley.edu # your email address # facebook_id: # your facebook id # flickr_id: # your flickr id github_username: liaochris diff --git a/_includes/header.liquid b/_includes/header.liquid index ab183c1..ed7ac2a 100644 --- a/_includes/header.liquid +++ b/_includes/header.liquid @@ -90,7 +90,9 @@ {{- child.title -}} @@ -108,7 +110,13 @@ {%- else -%} {%- assign url = p.url -%} {%- endif %} - + {{- p.title }} {% if page.url contains p.url %} (current) diff --git a/_includes/news.liquid b/_includes/news.liquid index ddf40b8..3112adc 100644 --- a/_includes/news.liquid +++ b/_includes/news.liquid @@ -16,7 +16,7 @@ {% endif %} {% for item in news limit: news_limit %} - {{ item.date | date: '%b %d, %Y' }} + {{ item.date | date: '%b %Y' }} {% if item.inline %} {{ item.content | remove: '

' | remove: '

' | emojify }} diff --git a/_layouts/bib.liquid b/_layouts/bib.liquid index b1b5217..d41bf0c 100644 --- a/_layouts/bib.liquid +++ b/_layouts/bib.liquid @@ -68,11 +68,11 @@ {%- if forloop.last and author_array_limit == author_array_size %}and {% endif -%} {% endif %} {%- if author_is_self -%} - - - {{- author.first }} - {{ author_last_html -}} - + + + {{- author.first }} + {{ author_last_html -}} + {%- else -%} {%- if coauthor_url -%} diff --git a/_news/announcement_berkeley.md b/_news/announcement_berkeley.md new file mode 100644 index 0000000..b033929 --- /dev/null +++ b/_news/announcement_berkeley.md @@ -0,0 +1,8 @@ +--- +layout: post +date: 2026-08-01 +inline: true +related_posts: false +--- + +**[Life update]** I started my PhD in economics at UC Berkeley. Feel free to reach out via email if you're in the Bay Area! diff --git a/_news/announcement_forest.md b/_news/announcement_forest.md index 9e87133..eefd605 100644 --- a/_news/announcement_forest.md +++ b/_news/announcement_forest.md @@ -5,4 +5,4 @@ inline: true related_posts: false --- -The working paper for **Generalized Random Forest Event Studies** is now available on my [research page](/research/). This brief note shows how generalized random forests can be used to estimate heterogeneous treatment effects in dynamic event study settings. \ No newline at end of file +**[New working paper]** [Generalized Random Forest Event Studies](/research/): I show how generalized random forests [(Athey et al. 2019)](https://doi.org/10.1214/18-AOS1709) can be used to estimate heterogeneous treatment effects in dynamic event study settings. diff --git a/_news/announcement_openai.md b/_news/announcement_openai.md new file mode 100644 index 0000000..8337b7b --- /dev/null +++ b/_news/announcement_openai.md @@ -0,0 +1,8 @@ +--- +layout: post +date: 2026-07-01 +inline: true +related_posts: false +--- + +**[Life update]** I joined OpenAI as a visiting economics researcher to study the economic impacts of AI. diff --git a/_news/announcement_resilience.md b/_news/announcement_resilience.md index 1d69ab5..9e53e26 100644 --- a/_news/announcement_resilience.md +++ b/_news/announcement_resilience.md @@ -5,5 +5,4 @@ inline: true related_posts: false --- -The working paper for **Organizational Resilience: Evidence from Open Source Software** is now available on my [research page](/research/). This paper studies what organizational practices are associated with increased organizational resilience. This doubled as my writing sample for graduate school applications. - +**[New working paper]** [Organizational Resilience: Evidence from Open Source Software](/research/): I show which organizational practices predict increased resilience to departures in open source software organizations. diff --git a/_pages/about.md b/_pages/about.md index e5174fc..4cf840a 100644 --- a/_pages/about.md +++ b/_pages/about.md @@ -2,13 +2,13 @@ layout: about title: about permalink: / -subtitle: +subtitle: profile: align: right image: prof_pic_color.png image_circular: false # crops the image to make it circular - more_info: > + more_info: > selected_papers: true # includes a list of papers marked as "selected={true}" social: true # includes social icons at the bottom of the page @@ -19,6 +19,6 @@ announcements: limit: 5 # leave blank to include all the news in the `_news` folder --- -I am an applied microeconomist interested in studying the digital economy and the economics of technology and organizations. My recent work leverages large-scale microdata on open source software organizations to learn what practices enable organizations to be more resilient to the departures of important members. +I am a first-year PhD student in Economics at [UC Berkeley](https://econ.berkeley.edu/), supported by the Chancellor's Fellowship. I am also a visiting economic researcher at [OpenAI](https://openai.com/). My research interests are in technology, innovation and organizations. -Since 2024, I have been a [Predoctoral Research Associate](https://www.hbs.edu/ra/predoctoral) at Harvard Business School working for Jesse Shapiro. I graduated from the University of Chicago in 2024, with a bachelor's in Economics (Honors) and a master's in Computer Science. In college, I interned at Citadel LLC as a Quantitative Trading Intern and worked as a research assistant for professors at Chicago Booth and NYU Stern. +I graduated from the University of Chicago in 2024, with a bachelor's in Economics (Honors) and a master's in Computer Science. In college, I worked as a research assistant on projects about consumer finance (with [Scott Nelson](https://www.chicagobooth.edu/faculty/directory/n/scott-nelson)) and economic history (with [Thomas Sargent](http://www.tomsargent.com/) and [George Hall](https://people.brandeis.edu/~ghall/)), and interned on Citadel's Global Fixed Income team. From 2024–2026, I was a Predoctoral Research Associate at Harvard Business School, working with [Jesse Shapiro](https://www.economics.harvard.edu/people/jesse-shapiro). diff --git a/assets/pdf/Resume.pdf b/assets/pdf/Resume.pdf index 5d56174..2a1a760 100644 Binary files a/assets/pdf/Resume.pdf and b/assets/pdf/Resume.pdf differ diff --git a/lighthouse_results/desktop/alshedivat_github_io_al_folio_.html b/lighthouse_results/desktop/alshedivat_github_io_al_folio_.html deleted file mode 100644 index 69b2bd1..0000000 --- a/lighthouse_results/desktop/alshedivat_github_io_al_folio_.html +++ /dev/null @@ -1,266 +0,0 @@ - - - - - - - - Lighthouse Report - - - - - -
- - - - - - diff --git a/lighthouse_results/desktop/pagespeed.svg b/lighthouse_results/desktop/pagespeed.svg deleted file mode 100644 index 0469799..0000000 --- a/lighthouse_results/desktop/pagespeed.svg +++ /dev/null @@ -1 +0,0 @@ -95Performance100Accessibility100Best Practices100SEONAPWA0-4950-8990-100 \ No newline at end of file diff --git a/lighthouse_results/mobile/alshedivat_github_io_al_folio_.html b/lighthouse_results/mobile/alshedivat_github_io_al_folio_.html deleted file mode 100644 index 5d52a5a..0000000 --- a/lighthouse_results/mobile/alshedivat_github_io_al_folio_.html +++ /dev/null @@ -1,266 +0,0 @@ - - - - - - - - Lighthouse Report - - - - - -
- - - - - - diff --git a/lighthouse_results/mobile/pagespeed.svg b/lighthouse_results/mobile/pagespeed.svg deleted file mode 100644 index 2cf0256..0000000 --- a/lighthouse_results/mobile/pagespeed.svg +++ /dev/null @@ -1 +0,0 @@ -92Performance100Accessibility100Best Practices100SEONAPWA0-4950-8990-100 \ No newline at end of file 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