Fixed docs (#3059)

Signed-off-by: George Araújo <george.gcac@gmail.com>
This commit is contained in:
George 2025-03-11 12:09:51 -03:00 committed by GitHub
parent 82b2ad388f
commit afc34968a7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 11 additions and 9 deletions

View File

@ -13,6 +13,7 @@ The project is structured as follows, focusing on the main components that you w
│   └── 📄 resume.json: CV in JSON format (https://jsonresume.org/) │   └── 📄 resume.json: CV in JSON format (https://jsonresume.org/)
├── 📂 _bibliography/ ├── 📂 _bibliography/
│   └── 📄 papers.bib: bibliography in BibTeX format │   └── 📄 papers.bib: bibliography in BibTeX format
├── 📂 _books/: contains the bookshelf pages
├── 📄 _config.yml: the configuration file of the template ├── 📄 _config.yml: the configuration file of the template
├── 📂 _data/: contains some of the data used in 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 │   ├── 📄 cv.yml: CV in YAML format, used when assets/json/resume.json is not found
@ -122,7 +123,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 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) ### Buttons (through custom bibtex keywords)

View File

@ -52,7 +52,7 @@ GEM
rexml rexml
csl-styles (1.0.1.11) csl-styles (1.0.1.11)
csl (~> 1.0) csl (~> 1.0)
css_parser (1.21.0) css_parser (1.21.1)
addressable addressable
cssminify2 (2.0.1) cssminify2 (2.0.1)
csv (3.3.2) csv (3.3.2)
@ -79,19 +79,19 @@ GEM
forwardable (1.3.3) forwardable (1.3.3)
forwardable-extended (2.6.0) forwardable-extended (2.6.0)
gemoji (4.1.0) gemoji (4.1.0)
google-protobuf (4.29.3) google-protobuf (4.30.0)
bigdecimal bigdecimal
rake (>= 13) rake (>= 13)
google-protobuf (4.29.3-aarch64-linux) google-protobuf (4.30.0-aarch64-linux)
bigdecimal bigdecimal
rake (>= 13) rake (>= 13)
google-protobuf (4.29.3-arm64-darwin) google-protobuf (4.30.0-arm64-darwin)
bigdecimal bigdecimal
rake (>= 13) rake (>= 13)
google-protobuf (4.29.3-x86_64-darwin) google-protobuf (4.30.0-x86_64-darwin)
bigdecimal bigdecimal
rake (>= 13) rake (>= 13)
google-protobuf (4.29.3-x86_64-linux) google-protobuf (4.30.0-x86_64-linux)
bigdecimal bigdecimal
rake (>= 13) rake (>= 13)
html-pipeline (2.14.3) html-pipeline (2.14.3)

View File

@ -13,6 +13,7 @@
- [For project pages](#for-project-pages) - [For project pages](#for-project-pages)
- [Enabling automatic deployment](#enabling-automatic-deployment) - [Enabling automatic deployment](#enabling-automatic-deployment)
- [Manual deployment to GitHub Pages](#manual-deployment-to-github-pages) - [Manual deployment to GitHub Pages](#manual-deployment-to-github-pages)
- [Deploy on Netlify](#deploy-on-netlify)
- [Deployment to another hosting server (non GitHub Pages)](#deployment-to-another-hosting-server-non-github-pages) - [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) - [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) - [Upgrading from a previous version](#upgrading-from-a-previous-version)
@ -210,7 +211,7 @@ If you installed **al-folio** as described above, you can manually update your c
# Assuming the current directory is <your-repo-name> # Assuming the current directory is <your-repo-name>
$ git remote add upstream https://github.com/alshedivat/al-folio.git $ git remote add upstream https://github.com/alshedivat/al-folio.git
$ git fetch upstream $ git fetch upstream
$ git rebase v0.14.0 $ git rebase v0.14.2
``` ```
If you have extensively customized a previous version, it might be trickier to upgrade. If you have extensively customized a previous version, it might be trickier to upgrade.

View File

@ -1,7 +1,7 @@
# this file uses prebuilt image in dockerhub # this file uses prebuilt image in dockerhub
services: services:
jekyll: jekyll:
image: amirpourmand/al-folio:v0.14.0 image: amirpourmand/al-folio:v0.14.2
build: . build: .
# uncomment these if you are having this issue with the build: # 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) # /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)