Installation

YAMLResume est un outil Node.js qui, sous le capot, transforme vos CV du format YAML vers le code LaTeX puis appelle un moteur de composition LaTeX pour compiler le code LaTeX généré en PDF. De plus, pour obtenir une sortie PDF optimale, nous suggérons également d'installer certaines polices. En résumé, vous devez installer les éléments suivants pour commencer avec YAMLResume :

• Node.js
• package yamlresume
• un moteur de composition
• [optionnel] quelques polices

Cela semble un peu compliqué, mais ne vous inquiétez pas, nous sommes là pour vous.

Utilisateurs Docker

Si vous êtes un utilisateur Docker, vous avez de la chance, nous avons une image docker pour vous. Cette image a tout pré-emballé, y compris :

• Node.js
• CLI yamlresume
• XeTeX
• quelques polices recommandées

Vous pouvez créer un nouveau CV instantanément avec la commande suivante :

docker run --rm -v $(pwd):/home/yamlresume yamlresume/yamlresume new my-resume.yml

Modifiez my-resume.yml en conséquence puis construisez le CV de yaml vers pdf :

docker run --rm -v $(pwd):/home/yamlresume yamlresume/yamlresume build my-resume.yml

En gros, vous pouvez appeler toutes les sous-commandes CLI yamlresume de cette façon—il suffit d'ajouter la sous-commande après yamlresume/yamlresume puis de suivre le guide d'utilisation correspondant.

Le flag -v ici est assez important car il monte le répertoire actuel ($(pwd)) dans le conteneur à /home/yamlresume, permettant une synchronisation bidirectionnelle de fichiers entre le répertoire local et le conteneur.

docker pull ghcr.io/yamlresume/yamlresume

Problèmes de Permissions

Parfois vous pourriez rencontrer des problèmes de permissions lors de l'exécution du conteneur Docker car l'image yamlresume/yamlresume est construite avec une instruction USER yamlresume, qui par défaut s'exécute avec moins de privilèges.

Il y a deux façons de résoudre ce problème :

1. Utiliser votre nom d'utilisateur/ID de groupe hôte pour exécuter le conteneur :

docker run --rm -v $(pwd):/home/yamlresume -u $(id -u):$(id -g) yamlresume/yamlresume new my-resume.yml

C'est la façon recommandée d'exécuter le conteneur. Tant que votre utilisateur hôte a accès au répertoire actuel, vous pouvez exécuter le conteneur avec votre nom d'utilisateur/ID de groupe hôte.

2. Utiliser -u root pour exécuter le conteneur avec accès root :

docker run --rm -v $(pwd):/home/yamlresume -u root yamlresume/yamlresume new my-resume.yml

C'est la façon la moins recommandée d'exécuter le conteneur. Ce n'est pas recommandé car cela peut causer des problèmes de sécurité, donc vous ne devriez faire cela que si vous êtes sûr de ce que vous faites.

Enfin, si vous exécutez le conteneur Docker yamlresume dans GitHub Actions, alors l'accès root peut être requis selon la documentation de GitHub :

Note: GitHub Actions must be run by the default Docker user (root). Ensure your Dockerfile does not set the USER instruction, otherwise you will not be able to access GITHUB_WORKSPACE.

Ref: Understanding the Docker USER Instruction

Utilisateurs Non-Docker

Si vous n'êtes pas un utilisateur Docker, veuillez suivre les instructions appropriées ci-dessous pour installer le CLI yamlresume et toutes les dépendances nécessaires basées sur votre système d'exploitation. Au moment de l'écriture, notre guide couvre macOS, Windows, et certaines distributions Linux (Ubuntu et distributions basées sur RHEL).

Node.js

Node.js 20.x ou plus récent est requis.

Il peut y avoir comme 100+ méthodes pour installer Node.js sur différents OS, vous pouvez consulter le téléchargement officiel Node.js pour commencer.

Nous recommandons d'utiliser un gestionnaire de paquets pour installer Node.js.

brew install node

choco install nodejs.install

sudo apt install nodejs

sudo dnf install nodejs

CLI YAMLResume

Installer yamlresume est un jeu d'enfant. Vous pouvez l'installer en utilisant votre gestionnaire de paquets Node.js préféré :

npm install -g yamlresume

pnpm add -g yamlresume

yarn global add yamlresume

bun add -g yamlresume

Vérifiez que yamlresume est installé avec succès :

$ yamlresume help
Usage: yamlresume [options] [command]

YAMLResume — Resume as Code in YAML

 __   __ _    __  __ _     ____
 \ \ / // \  |  \/  | |   |  _ \ ___  ___ _   _ ___  ___   ___
  \ V // _ \ | |\/| | |   | |_) / _ \/ __| | | / _ \/ _ \ / _ \
   | |/ ___ \| |  | | |___|  _ <  __/\__ \ |_| | | | | | |  __/
   |_/_/   \_\_|  |_|_____|_| \_\___||___/\____|_| |_| |_|\___|


Options:
  -V, --version                  output the version number
  -v, --verbose                  verbose output
  -h, --help                     display help for command

Commands:
  new [filename]                 create a new resume
  build [options] <resume-path>  build a resume to LaTeX and PDF
  dev [options] <resume-path>    build a resume on file changes (watch mode)
  languages                      i18n and l10n support
  templates                      manage resume templates
  validate <resume-path>         validate a resume against the YAMLResume schema
  help [command]                 display help for command

Si vous voulez juste essayer yamlresume sans l'installer, vous pouvez utiliser npx, pnpx ou d'autres outils similaires :

npx yamlresume help

yarn dlx yamlresume help

pnpx yamlresume help

bun exec yamlresume help

Moteur de Composition

Sous le capot, yamlresume fait le travail d'un compilateur, analysant un CV YAML vers un AST puis transformant l'AST en code LaTeX.

En tant que mini-compilateur, yamlresume s'appuie sur un moteur de composition pour compiler le code LaTeX généré en PDFs. Par conséquent, vous devez d'abord installer un moteur de composition avant de pouvoir utiliser yamlresume pour générer des PDFs de CV.

YAMLResume supporte actuellement deux moteurs de composition : XeTeX et Tectonic.

XeTeX

XeTeX est un moteur de composition TeX utilisant Unicode et supportant les technologies de police modernes comme OpenType, Graphite et Apple Advanced Typography (AAT).

C'est un moteur de composition très mature et stable qui est largement utilisé par de nombreuses personnes académiques et scientifiques.

brew install mactex

sudo apt install texlive-full

sudo apt install texlive-xetex texlive-fonts-extra texlive-lang-all

sudo dnf install texlive-scheme-full

sudo dnf install \
  texlive-scheme-medium \
  texlive-moderncv \
  texlive-ctex \
  texlive-academicons

Vérifiez que XeTeX est installé avec succès :

$ xetex -v
XeTeX 3.141592653-2.6-0.999994 (TeX Live 2022)
kpathsea version 6.3.4
Copyright 2022 SIL International, Jonathan Kew and Khaled Hosny.
There is NO warranty.  Redistribution of this software is
covered by the terms of both the XeTeX copyright and
the Lesser GNU General Public License.
For more information about these matters, see the file
named COPYING and the XeTeX source.
Primary author of XeTeX: Jonathan Kew.
Compiled with ICU version 70.1; using 70.1
Compiled with zlib version 1.2.11; using 1.2.11
Compiled with FreeType2 version 2.11.1; using 1.2.11
Compiled with Graphite2 version 1.3.14; using 1.3.14
Compiled with HarfBuzz version 3.4.0; using 3.4.0
Compiled with libpng version 1.6.37; using 1.6.37
Compiled with pplib version v2.05 less toxic i hope
Using Mac OS X Core Text and Cocoa frameworks

Tectonic

Tectonic est un moteur TeX/LaTeX moderne, complet et autonome, alimenté par XeTeX et TeXLive.

Une distribution TeX Live complète prend typiquement plusieurs GB d'espace disque, tandis que l'installation initiale de tectonic ne prend que 10+ MB. Il télécharge automatiquement les fichiers de support, donc vous n'avez pas besoin d'installer une distribution LaTeX complète. Quand vous commencez à utiliser un nouveau paquet LaTeX, Tectonic télécharge simplement les fichiers dont il a besoin et continue le traitement.

Tectonic fournit un guide d'installation officiel, mais cela mettrait juste tectonic dans le répertoire où vous avez exécuté la commande d'installation, yamlresume a besoin d'une commande globale tectonic dans votre $PATH, donc vous devez résoudre cela avec quelques astuces shell par vous-même.

Si vous êtes un utilisateur macOS, vous avez de la chance car Homebrew fournit un paquet pré-construit :

brew install tectonic

D'après mon expérience, tectonic a encore quelques problèmes de compatibilité mineurs avec XeTeX officiel, donc si vous ne vous souciez pas du long temps de téléchargement d'une distribution TeX Live complète, XeTeX est toujours le choix recommandé ici.

Police

Linux Libertine

YAMLResume adopte Linux Libertine comme police par défaut pour les caractères latins. Il est fortement recommandé de l'installer afin d'obtenir une sortie PDF optimale.

brew install font-linux-libertine

sudo apt install fonts-linuxlibertine

sudo dnf install linux-libertine-fonts

Google Noto

Si vous avez besoin de CV CJK, vous devrez aussi installer les polices Google Noto pour la meilleure couverture unicode.

brew install font-noto-sans-cjk font-noto-serif-cjk

sudo apt install fonts-noto-cjk fonts-noto-cjk-extra

sudo dnf install google-noto-sans-cjk-fonts google-noto-serif-cjk-fonts

Dépannage

Vous pouvez créer un problème si vous avez des difficultés à installer yamlresume ou ses dépendances.

Vous pouvez activer la journalisation verbeuse en passant un flag --verbose à yamlresume ou ses sous-commandes.

Vous en avez marre ?

Si vous en avez marre du processus d'installation, vous pouvez essayer PPResume, qui est une solution de constructeur de CV hébergée et commerciale qui a open sourcé YAMLResume.