Merge branch 'al-folio-main'

Author: george-gca

CUSTOMIZE.md

@@ -25,11 +25,15 @@ Note that throughout the [README.md](README.md) and [CUSTOMIZE.md](CUSTOMIZE.md)
     - [Key Integration Points](#key-integration-points)
   - [Modifying the CV information](#modifying-the-cv-information)
   - [Modifying the user and repository information](#modifying-the-user-and-repository-information)
+    - [Configuring external service URLs](#configuring-external-service-urls)
   - [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)
+    - [Creating a new collection](#creating-a-new-collection)
+    - [Using frontmatter fields in your collection](#using-frontmatter-fields-in-your-collection)
+    - [Collections with categories and tags](#collections-with-categories-and-tags)
   - [Adding a new publication](#adding-a-new-publication)
     - [Author annotation](#author-annotation)
     - [Buttons (through custom bibtex keywords)](#buttons-through-custom-bibtex-keywords)
@@ -278,6 +282,30 @@ What this means is, if there is no resume data defined in [\_config.yml](_config
 
 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.
 
+### Configuring external service URLs
+
+The repository page uses external services to display GitHub statistics and trophies. By default, these are:
+
+- `github-readme-stats.vercel.app` for user stats and repository cards
+- `github-profile-trophy.vercel.app` for GitHub profile trophies
+
+**Important:** These default services are hosted by third parties and may not be available 100% of the time. For better reliability, privacy, and customization, you can self-host these services and configure your website to use your own instances.
+
+To use your own instances of these services, configure the URLs in [\_config.yml](_config.yml):
+
+```yaml
+external_services:
+  github_readme_stats_url: https://github-readme-stats.vercel.app
+  github_profile_trophy_url: https://github-profile-trophy.vercel.app
+```
+
+To self-host these services, follow the deployment instructions in their respective repositories:
+
+- [github-readme-stats](https://github.com/anuraghazra/github-readme-stats)
+- [github-profile-trophy](https://github.com/ryo-ma/github-profile-trophy)
+
+Once deployed, update the URLs above to point to your custom deployment.
+
 ## 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. To have the page be displayed for different languages, simply create one markdown file with the same name in each language. It is possible to [use different permalinks per language](https://github.com/untra/polyglot?tab=readme-ov-file#using-different-permalinks-per-language) if you want to.
@@ -300,19 +328,105 @@ You can add news in the about page by adding new Markdown files in the [\_news/L
 
 ## 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`.
+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 the projects page, and items from the `books` collection are displayed on its own `bookshelf` page inside `submenus`.
+
+You can easily create your own collections for any type of content—teaching materials, courses, apps, short stories, or whatever suits your needs.
+
+### Creating a new collection
+
+To create a new collection, follow these steps. We will create a `teaching` collection, but you can replace `teaching` with any name you prefer:
+
+1. **Add the collection to `_config.yml`**
+
+   Open the `collections` section in [\_config.yml](_config.yml) and add your new collection:
+
+   ```yaml
+   collections:
+     news:
+       defaults:
+         layout: post
+       output: true
+     projects:
+       output: true
+     teaching:
+       output: true
+       permalink: /teaching/:path/
+   ```
+
+   - `output: true` makes the collection items accessible as separate pages
+   - `permalink` defines the URL path for each collection item (`:path` is replaced with the filename)
+     - Note: You can customize the [permalink structure](https://jekyllrb.com/docs/permalinks/#collections) as needed. If not set, it uses `/COLLECTION_NAME/:name/`.
+
+2. **Create a folder for your collection items**
+
+   Create a new folder in the root directory with an underscore prefix, matching your collection name. For a `teaching` collection, create `_teaching/`:
 
-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/LANG/projects.md](_pages/en-us/projects.md).
+   ```text
+   _teaching/
+   ├── course_1.md
+   ├── course_2.md
+   └── course_3.md
+   ```
+
+3. **Create a landing page for your collection**
+
+   Add a Markdown file in `_pages/` (e.g., `teaching.md`) that will serve as the main page for your collection. You can use [\_pages/projects.md](_pages/projects.md) or [\_pages/books.md](_pages/books.md) as a template and adapt it for your needs.
+
+   In your landing page, access your collection using the `site.COLLECTION_NAME` variable:
+
+   ```liquid
+   {% assign teaching_items = site.teaching | sort: 'date' | reverse %}
+
+   {% for item in teaching_items %}
+     <h3>{{ item.title }}</h3>
+     <p>{{ item.content }}</p>
+   {% endfor %}
+   ```
+
+   Replace `COLLECTION_NAME` with your actual collection name (e.g., `site.teaching`).
+
+4. **Add a link to your collection page**
+
+   Update [\_pages/dropdown.md](_pages/dropdown.md) or the navigation configuration in [\_config.yml](_config.yml) to add a menu link to your new page.
+
+5. **Create collection items**
+
+   Add Markdown files in your new collection folder (e.g., `_teaching/`) with appropriate frontmatter and content.
+
+For more information regarding collections, check [Jekyll official documentation](https://jekyllrb.com/docs/collections/) and [step-by=step guide](https://jekyllrb.com/docs/step-by-step/09-collections/).
+
+### Using frontmatter fields in your collection
+
+When creating items in your collection, you can define custom frontmatter fields and use them in your landing page. For example:
+
+```markdown
+---
+layout: page
+title: Introduction to Research Methods
+importance: 1
+category: methods
+---
+
+Course description and content here...
+```
+
+Then in your landing page template:
+
+```liquid
+{% if item.category == 'methods' %}
+  <span class="badge">{{ item.category }}</span>
+{% endif %}
+```
 
-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/).
+### Collections with categories and tags
 
-To access the collections, you can use the `site.COLLECTION_NAME` variable in your templates.
+If you want to add category and tag support (like the blog posts have), you need to configure the `jekyll-archives` section in [\_config.yml](_config.yml). See how this is done with the `books` collection for reference. For more details, check the [jekyll-archives-v2 documentation](https://george-gca.github.io/jekyll-archives-v2/).
 
 ## 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`.
+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`, `hal`, `html`, `isbn`, `pdf`, `pmid`, `poster`, `slides`, `supp`, `video`, and `website`.
 
 ### Author annotation
 
@@ -362,6 +476,7 @@ There are several custom bibtex keywords that you can use to affect how the entr
 - `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)
+- `hal`: Adds a link to the HAL website (Note: only add the hal identifier (hal-xxx or tel-xxx) 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)

README.md

@@ -134,7 +134,6 @@ Feel free to add your own page(s) by sending a PR.
 <a href="https://shubhashisroydipta.com/" target="_blank">★</a>
 <a href="https://astanziola.github.io" target="_blank">★</a>
 <a href="https://tinkerer.in" target="_blank">★</a>
-<a href="https://sam-bieberich.github.io/" target="_blank">★</a>
 <a href="https://afraniomelo.github.io/en/" target="_blank">★</a>
 <a href="https://jonaruthardt.github.io" target="_blank">★</a>
 <a href="https://www.zla.app/" target="_blank">★</a>
@@ -180,6 +179,8 @@ Feel free to add your own page(s) by sending a PR.
 <a href="https://zlatanajanovic.com/" target="_blank">★</a>
 <a href="https://mchadolias.github.io/" target="_blank">★</a>
 <a href="https://syanyong.github.io/" target="_blank">★</a>
+<a href="https://jucheval.github.io/" target="_blank">★</a>
+<a href="https://j1yoo.github.io/" target="_blank">★</a>
 </td>
 </tr>
 <tr>

_config.yml

@@ -27,6 +27,13 @@ repo_trophies:
   theme_light: flat # https://github.com/ryo-ma/github-profile-trophy
   theme_dark: gitdimmed # https://github.com/ryo-ma/github-profile-trophy
 
+# External service URLs for repository page
+# To use a different instance or service for displaying GitHub stats and trophies,
+# update these URLs. These are used in the repository templates.
+external_services:
+  github_readme_stats_url: https://github-readme-stats.vercel.app
+  github_profile_trophy_url: https://github-profile-trophy.vercel.app
+
 # -----------------------------------------------------------------------------
 # RSS Feed
 # -----------------------------------------------------------------------------
@@ -319,10 +326,14 @@ filtered_bibtex_keywords:
     bibtex_show,
     blog,
     code,
+    dimensions,
+    eprint,
     google_scholar_id,
+    hal,
     html,
     inspirehep_id,
     pdf,
+    pmid,
     poster,
     preview,
     selected,