diff --git a/.github/ISSUE_TEMPLATE/1_bug_report.yml b/.github/ISSUE_TEMPLATE/1_bug_report.yml index b95ae0c5d81d..f9c461f413c4 100644 --- a/.github/ISSUE_TEMPLATE/1_bug_report.yml +++ b/.github/ISSUE_TEMPLATE/1_bug_report.yml @@ -7,8 +7,8 @@ body: value: > Before you go any further. Is this really a **πŸ› bug**? - If it's a question about how al-folio works, have a look at our [documentation](https://github.com/alshedivat/al-folio/blob/master/README.md), - [frequently asked questions](https://github.com/alshedivat/al-folio/blob/master/FAQ.md), + If it's a question about how al-folio works, have a look at our [documentation](https://github.com/alshedivat/al-folio/blob/main/README.md), + [frequently asked questions](https://github.com/alshedivat/al-folio/blob/main/FAQ.md), [past questions](https://github.com/alshedivat/al-folio/discussions/categories/q-a), or [ask a question](https://github.com/alshedivat/al-folio/discussions/new?category=q-a). @@ -20,7 +20,7 @@ body: Please check if somebody else has already filed the same issue. If you find a similar issue, please add a πŸ‘ reaction or comment on the original post. options: - - label: I read through [FAQ](https://github.com/alshedivat/al-folio/blob/master/FAQ.md) and searched through the [past issues](https://github.com/alshedivat/al-folio/issues), none of which addressed my issue. + - label: I read through [FAQ](https://github.com/alshedivat/al-folio/blob/main/FAQ.md) and searched through the [past issues](https://github.com/alshedivat/al-folio/issues), none of which addressed my issue. required: true - label: Yes, I have checked that this issue isn't already filed. required: true diff --git a/.github/ISSUE_TEMPLATE/2_feature_request.yml b/.github/ISSUE_TEMPLATE/2_feature_request.yml index 36c218062a1d..6934f60c6087 100644 --- a/.github/ISSUE_TEMPLATE/2_feature_request.yml +++ b/.github/ISSUE_TEMPLATE/2_feature_request.yml @@ -7,8 +7,8 @@ body: value: > Before you go any further, are you sure that this feature is not already implemented? - If it's a question about how al-folio works, have a look at our [documentation](https://github.com/alshedivat/al-folio/blob/master/README.md), - [frequently asked questions](https://github.com/alshedivat/al-folio/blob/master/FAQ.md), + If it's a question about how al-folio works, have a look at our [documentation](https://github.com/alshedivat/al-folio/blob/main/README.md), + [frequently asked questions](https://github.com/alshedivat/al-folio/blob/main/FAQ.md), [past questions](https://github.com/alshedivat/al-folio/discussions/categories/q-a), or [ask a question](https://github.com/alshedivat/al-folio/discussions/new?category=q-a). @@ -20,7 +20,7 @@ body: Please check if somebody else has already filed the same πŸš€ feature request. If you find a similar feature request, please add a πŸ‘ reaction or comment on the original post. options: - - label: I read through [FAQ](https://github.com/alshedivat/al-folio/blob/master/FAQ.md) and searched through the [past issues](https://github.com/alshedivat/al-folio/issues), none of which addressed my feature request. + - label: I read through [FAQ](https://github.com/alshedivat/al-folio/blob/main/FAQ.md) and searched through the [past issues](https://github.com/alshedivat/al-folio/issues), none of which addressed my feature request. required: true - label: Yes, I have checked that this feature request isn't already filed. required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 5da20df00b4b..e8510012e8a2 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -4,5 +4,5 @@ contact_links: url: https://github.com/alshedivat/al-folio/discussions/categories/q-a about: Ask and answer al-folio related questions. - name: πŸ“– Read the documentation - url: https://github.com/alshedivat/al-folio/blob/master/README.md + url: https://github.com/alshedivat/al-folio/blob/main/README.md about: Please consult the documentation before opening any issues! diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 4672210ab724..a49432174d92 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -80,11 +80,16 @@ jobs: - name: Checkout πŸ›ŽοΈ uses: actions/checkout@v4 - - name: Setup Ruby + - name: Setup Ruby πŸ’Ž uses: ruby/setup-ruby@v1 with: - ruby-version: "3.2.2" + ruby-version: "3.3.5" bundler-cache: true + - name: Setup Python 🐍 + uses: actions/setup-python@v5 + with: + python-version: "3.13" + cache: "pip" # caching pip dependencies - name: Update _config.yml βš™οΈ uses: fjogeleit/yaml-update-action@main @@ -96,7 +101,7 @@ jobs: - name: Install and Build πŸ”§ run: | - pip3 install --upgrade jupyter + pip3 install --upgrade nbconvert export JEKYLL_ENV=production bundle exec jekyll build --lsi diff --git a/.github/workflows/schedule-posts.txt b/.github/workflows/schedule-posts.txt index fff22196f070..57728bca1e99 100644 --- a/.github/workflows/schedule-posts.txt +++ b/.github/workflows/schedule-posts.txt @@ -13,7 +13,7 @@ jobs: - name: Checkout main branch uses: actions/checkout@v4 with: - ref: master + ref: main - name: Get the date for today id: date diff --git a/.prettierignore b/.prettierignore index ea98f53b376f..ef61d8d86dec 100644 --- a/.prettierignore +++ b/.prettierignore @@ -9,3 +9,4 @@ assets/plotly/demo.html lighthouse_results/** _posts/2015-10-20-math.md _sass/font-awesome/*.scss +_sass/tabler-icons/*.scss diff --git a/Dockerfile b/Dockerfile index f704814abe10..c131f26d4282 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,42 +1,75 @@ FROM ruby:latest + +# uncomment these if you are having this issue with the build: +# /usr/local/bundle/gems/jekyll-4.3.4/lib/jekyll/site.rb:509:in `initialize': Permission denied @ rb_sysopen - /srv/jekyll/.jekyll-cache/.gitignore (Errno::EACCES) +# ARG GROUPID=901 +# ARG GROUPNAME=ruby +# ARG USERID=901 +# ARG USERNAME=jekyll + ENV DEBIAN_FRONTEND noninteractive -Label MAINTAINER Amir Pourmand +LABEL authors="Amir Pourmand,George AraΓΊjo" \ + description="Docker image for al-folio academic template" \ + maintainer="Amir Pourmand" -RUN apt-get update -y && apt-get install -y --no-install-recommends \ - locales \ - imagemagick \ - build-essential \ - zlib1g-dev \ - python3-pip \ - inotify-tools procps && \ - apt-get clean && rm -rf /var/lib/apt/lists/* /var/cache/apt/archives/* && \ - pip install nbconvert --break-system-packages +# uncomment these if you are having this issue with the build: +# /usr/local/bundle/gems/jekyll-4.3.4/lib/jekyll/site.rb:509:in `initialize': Permission denied @ rb_sysopen - /srv/jekyll/.jekyll-cache/.gitignore (Errno::EACCES) +# add a non-root user to the image with a specific group and user id to avoid permission issues +# RUN groupadd -r $GROUPNAME -g $GROUPID && \ +# useradd -u $USERID -m -g $GROUPNAME $USERNAME +# install system dependencies +RUN apt-get update -y && \ + apt-get install -y --no-install-recommends \ + build-essential \ + curl \ + imagemagick \ + inotify-tools \ + locales \ + nodejs \ + procps \ + python3-pip \ + zlib1g-dev && \ + pip --no-cache-dir install --upgrade --break-system-packages nbconvert +# clean up +RUN apt-get clean && \ + apt-get autoremove && \ + rm -rf /var/lib/apt/lists/* /var/cache/apt/archives/* /tmp/* + +# set the locale RUN sed -i '/en_US.UTF-8/s/^# //g' /etc/locale.gen && \ locale-gen - -ENV LANG=en_US.UTF-8 \ +# set environment variables +ENV EXECJS_RUNTIME=Node \ + JEKYLL_ENV=production \ + LANG=en_US.UTF-8 \ LANGUAGE=en_US:en \ - LC_ALL=en_US.UTF-8 \ - JEKYLL_ENV=production + LC_ALL=en_US.UTF-8 +# create a directory for the jekyll site RUN mkdir /srv/jekyll +# copy the Gemfile and Gemfile.lock to the image ADD Gemfile.lock /srv/jekyll ADD Gemfile /srv/jekyll +# set the working directory WORKDIR /srv/jekyll # install jekyll and dependencies -RUN gem install jekyll bundler - +RUN gem install --no-document jekyll bundler RUN bundle install --no-cache -# && rm -rf /var/lib/gems/3.1.0/cache + EXPOSE 8080 COPY bin/entry_point.sh /tmp/entry_point.sh +# uncomment this if you are having this issue with the build: +# /usr/local/bundle/gems/jekyll-4.3.4/lib/jekyll/site.rb:509:in `initialize': Permission denied @ rb_sysopen - /srv/jekyll/.jekyll-cache/.gitignore (Errno::EACCES) +# set the ownership of the jekyll site directory to the non-root user +# USER $USERNAME + CMD ["/tmp/entry_point.sh"] diff --git a/FAQ.md b/FAQ.md index ac8959e35d1f..7d2bb09067d1 100644 --- a/FAQ.md +++ b/FAQ.md @@ -10,7 +10,7 @@ Here are some frequently asked questions. If you have a different question, plea - [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 master 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-master-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?](#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 Font Awesome version on the template](#how-can-i-update-font-awesome-version-on-the-template) @@ -26,7 +26,7 @@ Yes, if you are using release `v0.3.5` or later, the website will 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? -You need to add `CNAME` file to the `master` 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).) +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).) --- @@ -74,15 +74,15 @@ You need to [create a personal access token](https://docs.github.com/en/authenti --- -### My code runs fine locally, but when I create a commit and submit it, it fails with `prettier code formatter workflow run failed for master 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? 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/master/INSTALL.md#local-setup-with-development-containers), `Prettier` is already included +- 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/master/.github/workflows/prettier.yml). +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). --- @@ -134,6 +134,6 @@ Currently we have the following workflows: - `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/master/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) +- `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/master/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-master-branch-how-do-i-fix-that) +- `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) diff --git a/Gemfile b/Gemfile index fa34c9646671..9637fc01ed9b 100644 --- a/Gemfile +++ b/Gemfile @@ -18,7 +18,6 @@ group :jekyll_plugins do gem 'jekyll-toc' gem 'jekyll-twitter-plugin' gem 'jemoji' - gem 'mini_racer' gem 'unicode_utils' gem 'webrick' end diff --git a/Gemfile.lock b/Gemfile.lock index bb9672cca361..d5b00b6865b3 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,7 +1,7 @@ GEM remote: https://rubygems.org/ specs: - activesupport (7.2.1) + activesupport (7.2.1.1) base64 bigdecimal concurrent-ruby (~> 1.0, >= 1.3.1) @@ -36,7 +36,7 @@ GEM rexml csl-styles (1.0.1.11) csl (~> 1.0) - css_parser (1.19.0) + css_parser (1.19.1) addressable cssminify2 (2.0.1) csv (3.3.0) @@ -52,17 +52,29 @@ GEM loofah (>= 2.3.1, < 3) sax-machine (>= 1.0, < 2) ffi (1.17.0-aarch64-linux-gnu) + ffi (1.17.0-aarch64-linux-musl) + ffi (1.17.0-arm-linux-gnu) + ffi (1.17.0-arm-linux-musl) ffi (1.17.0-arm64-darwin) + ffi (1.17.0-x86-linux-gnu) + ffi (1.17.0-x86-linux-musl) ffi (1.17.0-x86_64-darwin) ffi (1.17.0-x86_64-linux-gnu) + ffi (1.17.0-x86_64-linux-musl) forwardable-extended (2.6.0) gemoji (4.1.0) + google-protobuf (4.28.2) + bigdecimal + rake (>= 13) google-protobuf (4.28.2-aarch64-linux) bigdecimal rake (>= 13) google-protobuf (4.28.2-arm64-darwin) bigdecimal rake (>= 13) + google-protobuf (4.28.2-x86-linux) + bigdecimal + rake (>= 13) google-protobuf (4.28.2-x86_64-darwin) bigdecimal rake (>= 13) @@ -147,10 +159,6 @@ GEM kramdown-parser-gfm (1.1.0) kramdown (~> 2.0) latex-decode (0.4.0) - libv8-node (22.7.0.4-aarch64-linux) - libv8-node (22.7.0.4-arm64-darwin) - libv8-node (22.7.0.4-x86_64-darwin) - libv8-node (22.7.0.4-x86_64-linux) liquid (4.0.4) listen (3.9.0) rb-fsevent (~> 0.10, >= 0.10.3) @@ -162,8 +170,6 @@ GEM matrix (0.4.2) mercenary (0.4.0) mini_mime (1.1.5) - mini_racer (0.15.0) - libv8-node (~> 22.7.0.1) minitest (5.25.1) multi_xml (0.7.1) bigdecimal (~> 3.1) @@ -171,8 +177,12 @@ GEM racc (~> 1.7) nokogiri (1.16.7-aarch64-linux) racc (~> 1.4) + nokogiri (1.16.7-arm-linux) + racc (~> 1.4) nokogiri (1.16.7-arm64-darwin) racc (~> 1.4) + nokogiri (1.16.7-x86-linux) + racc (~> 1.4) nokogiri (1.16.7-x86_64-darwin) racc (~> 1.4) nokogiri (1.16.7-x86_64-linux) @@ -185,17 +195,29 @@ GEM rb-fsevent (0.11.2) rb-inotify (0.11.1) ffi (~> 1.0) - rexml (3.3.7) + rexml (3.3.8) rouge (4.4.0) safe_yaml (1.0.5) - sass-embedded (1.79.3-aarch64-linux-gnu) - google-protobuf (~> 4.27) - sass-embedded (1.79.3-arm64-darwin) - google-protobuf (~> 4.27) - sass-embedded (1.79.3-x86_64-darwin) - google-protobuf (~> 4.27) - sass-embedded (1.79.3-x86_64-linux-gnu) - google-protobuf (~> 4.27) + sass-embedded (1.80.3-aarch64-linux-gnu) + google-protobuf (~> 4.28) + sass-embedded (1.80.3-aarch64-linux-musl) + google-protobuf (~> 4.28) + sass-embedded (1.80.3-arm-linux-gnueabihf) + google-protobuf (~> 4.28) + sass-embedded (1.80.3-arm-linux-musleabihf) + google-protobuf (~> 4.28) + sass-embedded (1.80.3-arm64-darwin) + google-protobuf (~> 4.28) + sass-embedded (1.80.3-x86-linux-gnu) + google-protobuf (~> 4.28) + sass-embedded (1.80.3-x86-linux-musl) + google-protobuf (~> 4.28) + sass-embedded (1.80.3-x86_64-darwin) + google-protobuf (~> 4.28) + sass-embedded (1.80.3-x86_64-linux-gnu) + google-protobuf (~> 4.28) + sass-embedded (1.80.3-x86_64-linux-musl) + google-protobuf (~> 4.28) sax-machine (1.3.2) securerandom (0.3.1) terminal-table (3.0.2) @@ -210,9 +232,20 @@ GEM PLATFORMS aarch64-linux + aarch64-linux-gnu + aarch64-linux-musl + arm-linux + arm-linux-gnu + arm-linux-gnueabihf + arm-linux-musl + arm-linux-musleabihf arm64-darwin + x86-linux + x86-linux-gnu + x86-linux-musl x86_64-darwin - x86_64-linux + x86_64-linux-gnu + x86_64-linux-musl DEPENDENCIES classifier-reborn @@ -236,9 +269,8 @@ DEPENDENCIES jekyll-toc jekyll-twitter-plugin jemoji - mini_racer unicode_utils webrick BUNDLED WITH - 2.5.7 + 2.5.18 diff --git a/INSTALL.md b/INSTALL.md index 71c938ff18fe..9bebeae2e8f3 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -26,8 +26,8 @@ The recommended approach for using **al-folio** is to first create your own site 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` 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 `master` 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 master). +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: @@ -120,8 +120,8 @@ Starting version [v0.3.5](https://github.com/alshedivat/al-folio/releases/tag/v0 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 `master` 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 `master`). For more details, see [Configuring a publishing source for your GitHub Pages site](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#choosing-a-publishing-source). +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. diff --git a/README.md b/README.md index 1a29500949bd..605b1d4af052 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ [![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/master/LICENSE) +[![GitHub license](https://img.shields.io/github/license/alshedivat/al-folio?color=blue)](https://github.com/alshedivat/al-folio/blob/main/LICENSE) [![GitHub stars](https://img.shields.io/github/stars/alshedivat/al-folio)](https://github.com/alshedivat/al-folio) [![GitHub forks](https://img.shields.io/github/forks/alshedivat/al-folio)](https://github.com/alshedivat/al-folio/fork) @@ -157,6 +157,9 @@ Feel free to add your own page(s) by sending a PR. β˜… β˜… β˜… +β˜… +β˜… +β˜… @@ -206,13 +209,13 @@ Workshop on Structured Probabilistic Inference & Generative Modeling (ICML: google_analytics: # your Google Analytics measurement ID (format: G-XXXXXXXXXX) cronitor_analytics: # cronitor RUM analytics site ID (format: XXXXXXXXX) pirsch_analytics: # your Pirsch analytics site ID (length 32 characters) +openpanel_analytics: # your Openpanel analytics client ID (format: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX) google_site_verification: T2ERe-qbEapqTlC7TiojiwFWn27ACCJYx8ws5ZRwmq0 # your google-site-verification ID (Google Search Console) bing_site_verification: # out your bing-site-verification ID (Bing Webmaster) @@ -435,6 +436,7 @@ lazy_loading_images: true # enables lazy loading of images (recommended) enable_google_analytics: false # enables google analytics enable_cronitor_analytics: false # enables cronitor RUM analytics enable_pirsch_analytics: false # enables Pirsch analytics (https://pirsch.io/) +enable_openpanel_analytics: false # enables Openpanel analytics (https://openpanel.dev/) enable_google_verification: false # enables google site verification enable_bing_verification: false # enables bing site verification enable_masonry: true # enables automatic project cards arrangement diff --git a/_includes/figure.liquid b/_includes/figure.liquid index a8d54dab5dbd..191c63800613 100644 --- a/_includes/figure.liquid +++ b/_includes/figure.liquid @@ -16,14 +16,14 @@ {% if site.imagemagick.enabled %} - {{ trail.num }} + {{ trail.num }} {% endfor %} {% endif %} diff --git a/_includes/scripts/analytics.liquid b/_includes/scripts/analytics.liquid index 4419a2cecfe8..2b9b1223e454 100644 --- a/_includes/scripts/analytics.liquid +++ b/_includes/scripts/analytics.liquid @@ -19,7 +19,7 @@ function () { (window.cronitor.q = window.cronitor.q || []).push(arguments); }; - cronitor('config', { clientKey: '{{site.cronitor_analytics}}' }); + cronitor('config', { clientKey: '{{ site.cronitor_analytics }}' }); {% endif %} {% if site.enable_pirsch_analytics %} @@ -30,3 +30,19 @@ data-code="{{ site.pirsch_analytics }}" > {% endif %} +{% if site.enable_openpanel_analytics %} + + +{% endif %} diff --git a/_includes/scripts/search.liquid b/_includes/scripts/search.liquid index 95e219cac62d..a1be0482419c 100644 --- a/_includes/scripts/search.liquid +++ b/_includes/scripts/search.liquid @@ -215,7 +215,7 @@ title: 'ResearchGate', section: 'Socials', handler: () => { - window.open("https://www.researchgate.net/profile/{{site.research_gate_profile}}/", "_blank"); + window.open("https://www.researchgate.net/profile/{{ site.research_gate_profile }}/", "_blank"); }, }, {%- endif -%} @@ -225,7 +225,7 @@ title: 'IEEE Xplore', section: 'Socials', handler: () => { - window.open("https://ieeexplore.ieee.org/author/{{site.ieee_id}}/", "_blank"); + window.open("https://ieeexplore.ieee.org/author/{{ site.ieee_id }}/", "_blank"); }, }, {%- endif -%} @@ -235,7 +235,7 @@ title: 'ACM DL', section: 'Socials', handler: () => { - window.open("https://dl.acm.org/profile/{{site.acm_id}}/", "_blank"); + window.open("https://dl.acm.org/profile/{{ site.acm_id }}/", "_blank"); }, }, {%- endif -%} @@ -245,7 +245,7 @@ title: 'Scopus', section: 'Socials', handler: () => { - window.open("https://www.scopus.com/authid/detail.uri?authorId={{site.scopus_id}}", "_blank"); + window.open("https://www.scopus.com/authid/detail.uri?authorId={{ site.scopus_id }}", "_blank"); }, }, {%- endif -%} diff --git a/_includes/scripts/wechatModal.liquid b/_includes/scripts/wechatModal.liquid index 17285b3032cb..51e9b2b2c27d 100644 --- a/_includes/scripts/wechatModal.liquid +++ b/_includes/scripts/wechatModal.liquid @@ -3,11 +3,13 @@