Merge tag 'v0.14.6'

Author: Szymok

.github/workflows/broken-links.yml

@@ -41,6 +41,8 @@ on:
 jobs:
   link-checker:
     runs-on: ubuntu-latest
+    # only run on the main repo
+    if: github.repository == 'alshedivat/al-folio'
     steps:
       - uses: actions/checkout@v4
 

.github/workflows/deploy.yml

@@ -8,6 +8,7 @@ on:
     paths:
       - "assets/**"
       - "_sass/**"
+      - "_scripts/**"
       - "**.bib"
       - "**.html"
       - "**.js"
@@ -36,6 +37,7 @@ on:
     paths:
       - "assets/**"
       - "_sass/**"
+      - "_scripts/**"
       - "**.bib"
       - "**.html"
       - "**.js"

.github/workflows/update-tocs.yml

@@ -0,0 +1,50 @@
+name: Update TOCs
+# This workflow automatically updates the Table of Contents (TOC) in markdown files
+
+on:
+  push:
+    branches:
+      - main
+      - master
+    paths:
+      - "*.md"
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # OR "2" -> To retrieve the preceding commit.
+
+      - name: Get changed files
+        id: changed-files
+        uses: tj-actions/changed-files@ed68ef82c095e0d48ec87eccea555d944a631a4c # v46
+        with:
+          files: ./*.md
+
+      - name: Updated toc on all markdown changed files
+        env:
+          ALL_CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }}
+        run: |
+          curl https://raw.githubusercontent.com/george-gca/github-markdown-toc/main/gh-md-toc -o gh-md-toc
+          chmod a+x gh-md-toc
+          for file in ${ALL_CHANGED_FILES}; do
+            # Check if the file is a markdown file
+            if [[ "$file" != *.md ]]; then
+              continue
+            fi
+            ./gh-md-toc --indent 2 --insert --no-backup --hide-footer $file
+          done
+          rm gh-md-toc
+
+      - name: Commit changes
+        if: steps.changed-files.outputs.any_changed == 'true'
+        uses: stefanzweifel/git-auto-commit-action@v5.0.1
+        with:
+          commit_message: Auto update markdown TOC

.prettierignore

@@ -9,4 +9,4 @@ lighthouse_results/**
 _posts/2015-10-20-math.md
 _sass/font-awesome/*.scss
 _sass/tabler-icons/*.scss
-_scripts/search.liquid.js
+_scripts/*

CUSTOMIZE.md

@@ -2,6 +2,9 @@
 
 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.
 
+<!--ts-->
+<!--te-->
+
 ## Project structure
 
 The project is structured as follows, focusing on the main components that you will need to modify:
@@ -13,6 +16,7 @@ The project is structured as follows, focusing on the main components that you w
     │   └── 📄 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
@@ -122,7 +126,7 @@ If the entry matches one form of the last names and the first names, it will be
     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.
+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)
 
@@ -162,10 +166,10 @@ Depending on your specified footer behavior, the sign up form either will appear
 
 ## 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 `excludes` section in your `_config.yml` file instead of actually deleting them, for example:
+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
-excludes:
+exclude:
   - _news/announcement_*.md
   - _pages/blog.md
   - _posts/