Skip to content

Commit

Permalink
Merge branch 'al-folio-main'
Browse files Browse the repository at this point in the history
  • Loading branch information
george-gca committed Jun 24, 2024
2 parents b4b7993 + f4a6e18 commit 26c97e5
Show file tree
Hide file tree
Showing 21 changed files with 442 additions and 22 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/deploy-docker-tag.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ on:
tags:
- "v*"
paths:
- ".github/workflows/deploy-docker-tag.yml"
- ".github/workflows/deploy-image.yml"
- "bin/entry_point.sh"
- "Dockerfile"
- "Gemfile"
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/deploy-image.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ on:
- master
- main
paths:
- ".github/workflows/deploy-image.yml"
- "bin/entry_point.sh"
- "Dockerfile"
- "Gemfile"
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ on:
- main
paths:
- "assets/**"
- "**.bib"
- "**.html"
- "**.js"
- "**.liquid"
Expand All @@ -33,6 +34,7 @@ on:
- main
paths:
- "assets/**"
- "**.bib"
- "**.html"
- "**.js"
- "**.liquid"
Expand Down
8 changes: 7 additions & 1 deletion .github/workflows/docker-slim.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@ 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:
Expand All @@ -15,7 +21,7 @@ on:
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' and github.repository_owner == 'george-gca }}'
if: ${{ github.event.workflow_run.conclusion == 'success' && github.repository_owner == 'george-gca' }}
runs-on: ubuntu-latest
defaults:
run:
Expand Down
9 changes: 8 additions & 1 deletion CUSTOMIZE.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ You can easily create your own collections, apps, short stories, courses, or wha

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`, `arxiv`, `bibtex_show`, `blog`, `code`, `dimensions`, `doi`, `eprint`, `html`, `isbn`, `pdf`, `pmid`, `poster`, `slides`, `supp`, `video`, and `website`.
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

Expand Down Expand Up @@ -138,6 +138,7 @@ There are several custom bibtex keywords that you can use to affect how the entr
- `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
Expand All @@ -159,3 +160,9 @@ A variety of beautiful theme colors have been selected for you to choose from. T
## Adding social media information

You can add your social media links by adding the specified information at the `Social integration` section in the [\_config.yml](_config.yml) file. This information will appear at the bottom of the `About` page.

## 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.
1 change: 1 addition & 0 deletions Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ group :jekyll_plugins do
gem 'jekyll-minifier'
gem 'jekyll-paginate-v2'
gem 'jekyll-polyglot'
gem 'jekyll-regex-replace'
gem 'jekyll-scholar'
gem 'jekyll-sitemap'
gem 'jekyll-tabs'
Expand Down
2 changes: 2 additions & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@ GEM
jekyll (>= 3.0, < 5.0)
jekyll-polyglot (1.8.0)
jekyll (>= 4.0, >= 3.0)
jekyll-regex-replace (1.1.0)
jekyll-sass-converter (3.0.0)
sass-embedded (~> 1.54)
jekyll-scholar (7.1.3)
Expand Down Expand Up @@ -208,6 +209,7 @@ DEPENDENCIES
jekyll-minifier
jekyll-paginate-v2
jekyll-polyglot
jekyll-regex-replace
jekyll-scholar
jekyll-sitemap
jekyll-tabs
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,7 @@ Feel free to add your own page(s) by sending a PR.
<a href="https://jackjburnett.github.io/" target="_blank">★</a>
<a href="https://physics-morris.github.io/" target="_blank">★</a>
<a href="https://sraf.ir" target="_blank">★</a>
<a href="https://acad.garywei.dev/" target="_blank">★</a>
</td>
</tr>
<tr>
Expand Down
3 changes: 2 additions & 1 deletion _bibliography/papers.bib
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ @article{einstein1950meaning
@article{PhysRev.47.777,
abbr={PhysRev},
title={Can Quantum-Mechanical Description of Physical Reality Be Considered Complete?},
author={Einstein, A. and Podolsky, B. and Rosen, N.},
author={Einstein*†, A. and Podolsky*, B. and Rosen*, N.},
abstract={In a complete theory there is an element corresponding to each element of reality. A sufficient condition for the reality of a physical quantity is the possibility of predicting it with certainty, without disturbing the system. In quantum mechanics in the case of two physical quantities described by non-commuting operators, the knowledge of one precludes the knowledge of the other. Then either (1) the description of reality given by the wave function in quantum mechanics is not complete or (2) these two quantities cannot have simultaneous reality. Consideration of the problem of making predictions concerning a system on the basis of measurements made on another system that had previously interacted with it leads to the result that if (1) is false then (2) is also false. One is thus led to conclude that the description of reality as given by a wave function is not complete.},
journal={Phys. Rev.},
location={New Jersey},
Expand All @@ -56,6 +56,7 @@ @article{PhysRev.47.777
google_scholar_id={qyhmnyLat1gC},
video={https://www.youtube-nocookie.com/embed/aqz-KE-bpKQ},
additional_info={. *More Information* can be [found here](https://github.com/alshedivat/al-folio/)},
annotation={* Example use of superscripts<br>† Albert Einstein},
selected={true}
}

Expand Down
13 changes: 12 additions & 1 deletion _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ related_blog_posts:
# Giscus comments (RECOMMENDED)
# Follow instructions on https://giscus.app/ to setup for your repo to fill out the information below.
giscus:
repo: george-gca/multi-language-al-folio # <your-github-user-name>/<your-github-repo-name>
repo: # <your-github-user-name>/<your-github-repo-name>
repo_id: R_kgDOI6hBvA # leave empty or specify your repo_id (see https://giscus.app/)
category: Comments # name of the category under which discussions will be created
category_id: DIC_kwDOI6hBvM4CYHn3 # leave empty or specify your category_id (see https://giscus.app/)
Expand All @@ -162,6 +162,15 @@ external_sources:
- url: https://blog.google/technology/ai/google-gemini-update-flash-ai-assistant-io-2024/
published_date: 2024-05-14

# -----------------------------------------------------------------------------
# Newsletter
# -----------------------------------------------------------------------------

newsletter:
enabled: false
endpoint: # your loops endpoint (e.g., https://app.loops.so/api/newsletter-form/YOUR-ENDPOINT)
# https://loops.so/docs/forms/custom-form

# -----------------------------------------------------------------------------
# Collections
# -----------------------------------------------------------------------------
Expand Down Expand Up @@ -243,6 +252,7 @@ plugins:
- jekyll-minifier
- jekyll-paginate-v2
- jekyll-polyglot
- jekyll-regex-replace
- jekyll/scholar
- jekyll-sitemap
- jekyll-tabs
Expand Down Expand Up @@ -330,6 +340,7 @@ filtered_bibtex_keywords:
abstract,
additional_info,
altmetric,
annotation,
arxiv,
award,
award_name,
Expand Down
6 changes: 4 additions & 2 deletions _data/repositories.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,14 @@ github_users:
- torvalds
- alshedivat

repo_description_lines_max: 2

github_repos:
- george-gca/multi-language-al-folio
- alshedivat/al-folio
- twbs/bootstrap
- jekyll/jekyll
- twbs/bootstrap
- jquery/jquery
- FortAwesome/Font-Awesome
- jpswalsh/academicons
- mathjax/MathJax
- jpswalsh/academicons
4 changes: 4 additions & 0 deletions _includes/footer.liquid
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@
</footer>
{% else %}
<footer class="sticky-bottom mt-5" role="contentinfo">
{% if site.newsletter.enabled %}
{% include scripts/newsletter.liquid %}
{% endif %}

<div class="container">
&copy; Copyright {{ site.time | date: '%Y' }}
{{ site.first_name }}
Expand Down
4 changes: 4 additions & 0 deletions _includes/related_posts.liquid
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,7 @@
<a class="text-pink-700 underline font-semibold hover:text-pink-800" href="{{ site.baseurl }}{{ post.url }}">{{ post.title }}</a>
</li>
{% endfor %}
{% if site.newsletter.enabled and site.footer_fixed %}
<p class="mb-2" style="margin-top: 1.5rem !important">Subscribe to be notified of future articles:</p>
{% include scripts/newsletter.liquid left=true %}
{% endif %}
10 changes: 8 additions & 2 deletions _includes/repository/repo.liquid
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,24 @@
{% assign lang = site.active_lang %}
{% endif %}

{% if site.data.repositories.repo_description_lines_max %}
{% assign max_lines = site.data.repositories.repo_description_lines_max %}
{% else %}
{% assign max_lines = 2 %}
{% endif %}

<div class="repo p-2 text-center">
<a href="https://github.com/{{ include.repository }}">
{% comment %} available locales: https://github.com/anuraghazra/github-readme-stats?tab=readme-ov-file#available-locales {% endcomment %}
<img
class="repo-img-light w-100"
alt="{{ include.repository }}"
src="https://github-readme-stats.vercel.app/api/pin/?username={{ repo_url[0] }}&repo={{ repo_url[1] }}&theme={{ site.repo_theme_light }}&locale={{ lang }}&show_owner={{ show_owner }}"
src="https://github-readme-stats.vercel.app/api/pin/?username={{ repo_url[0] }}&repo={{ repo_url[1] }}&theme={{ site.repo_theme_light }}&locale={{ lang }}&show_owner={{ show_owner }}&description_lines_count={{ max_lines }}"
>
<img
class="repo-img-dark w-100"
alt="{{ include.repository }}"
src="https://github-readme-stats.vercel.app/api/pin/?username={{ repo_url[0] }}&repo={{ repo_url[1] }}&theme={{ site.repo_theme_dark }}&locale={{ lang }}&show_owner={{ show_owner }}"
src="https://github-readme-stats.vercel.app/api/pin/?username={{ repo_url[0] }}&repo={{ repo_url[1] }}&theme={{ site.repo_theme_dark }}&locale={{ lang }}&show_owner={{ show_owner }}&description_lines_count={{ max_lines }}"
>
</a>
</div>
Loading

0 comments on commit 26c97e5

Please sign in to comment.