Instalação

O YAMLResume é uma ferramenta Node.js, por baixo do capô, transforma os seus currículos do formato YAML para código LaTeX e depois chama um motor de composição tipográfica LaTeX para compilar o código LaTeX gerado para PDF. Além disso, para obter uma saída PDF ótima, também sugerimos instalar algumas fontes. Em resumo, precisa de instalar o seguinte para começar com o YAMLResume:

• Node.js
• pacote yamlresume
• um motor de composição tipográfica
• [opcional] algumas fontes

Isto parece um pouco complicado, mas não se preocupe, nós cobrimos tudo.

Utilizadores de Docker

Se é utilizador de docker, tem sorte, temos uma imagem de docker para si. Esta imagem tem tudo pré-embalado, incluindo:

• Node.js
• CLI yamlresume
• XeTeX
• algumas fontes recomendadas

Pode criar um novo currículo instantaneamente com o seguinte comando:

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

Edite my-resume.yml em conformidade e depois construa o currículo de yaml para pdf:

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

Basicamente, pode chamar todos os subcomandos do CLI do yamlresume desta forma—basta adicionar o subcomando depois de yamlresume/yamlresume e depois seguir o guia de utilização correspondente.

A flag -v aqui é bastante importante porque monta o diretório atual ($(pwd)) no contentor em /home/yamlresume, permitindo uma sincronização de ficheiros bidirecional entre o diretório local e o contentor.

docker pull ghcr.io/yamlresume/yamlresume

Problemas de Permissões

Por vezes pode encontrar problemas de permissões ao executar o contentor Docker porque a imagem yamlresume/yamlresume é construída com uma instrução USER yamlresume, que por defeito é executada com menos privilégios.

Há duas formas de resolver este problema:

1. Use o seu nome de utilizador/ID de grupo do host para executar o contentor:

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

Esta é a forma recomendada de executar o contentor. Sempre que o seu utilizador host tiver acesso ao diretório atual, pode executar o contentor com o seu nome de utilizador/ID de grupo do host.

2. Use -u root para executar o contentor com acesso root:

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

Esta é a forma menos recomendada de executar o contentor. Não é recomendada porque pode causar problemas de segurança, por isso só deve fazer isto se tiver a certeza do que está a fazer.

Por último, mas não menos importante, se estiver a executar o contentor Docker yamlresume no GitHub Actions, então o acesso root pode ser necessário de acordo com a documentação do GitHub:

Nota: O GitHub Actions deve ser executado pelo utilizador Docker padrão (root). Certifique-se de que o seu Dockerfile não define a instrução USER, caso contrário não poderá aceder ao GITHUB_WORKSPACE.

Ref: Compreendendo a Instrução USER do Docker

Utilizadores Não-Docker

Se não é um utilizador de docker, siga as instruções apropriadas abaixo para instalar o CLI yamlresume e todas as dependências necessárias de acordo com o seu sistema operativo. No momento em que escrevo isto, o nosso guia cobre macOS, Windows e algumas distribuições Linux (Ubuntu e distribuições baseadas em RHEL).

Node.js

É necessário Node.js 20.x ou posterior.

Pode haver mais de 100 métodos para instalar Node.js em diferentes sistemas operativos, pode consultar a Descarga oficial do Node.js para começar.

Recomendamos usar um gestor de pacotes para instalar o Node.js.

brew install node

choco install nodejs.install

sudo apt install nodejs

sudo dnf install nodejs

CLI do YAMLResume

Instalar yamlresume é muito fácil. Pode instalá-lo usando o seu gestor de pacotes Node.js favorito:

npm install -g yamlresume

pnpm add -g yamlresume

yarn global add yamlresume

bun add -g yamlresume

Se é utilizador de macOS e usa Homebrew, também pode instalar yamlresume via Homebrew:

brew install yamlresume

Verifique que yamlresume foi instalado corretamente:

$ 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

Se apenas quiser experimentar o yamlresume sem o instalar, pode usar npx, pnpx ou outras ferramentas semelhantes:

npx yamlresume help

yarn dlx yamlresume help

pnpx yamlresume help

bun exec yamlresume help

Motor de Composição Tipográfica

Por baixo do capô, o yamlresume faz o trabalho de um compilador, analisando um currículo YAML para um AST e depois transformando o AST para código LaTeX.

Como um mini-compilador, o yamlresume depende de um motor de composição tipográfica para compilar o código LaTeX gerado para PDFs. Portanto, primeiro deve instalar um motor de composição tipográfica antes de poder usar o yamlresume para gerar PDFs de currículo.

O YAMLResume atualmente suporta dois motores de composição tipográfica: XeTeX e Tectonic.

XeTeX

XeTeX é um motor de composição tipográfica TeX que usa Unicode e suporta tecnologias de fontes modernas como OpenType, Graphite e Apple Advanced Typography (AAT).

É um motor de composição tipográfica muito maduro e estável que é amplamente utilizado por muitas pessoas académicas e científicas.

# install the full mactex
brew install mactex
# or if you want to save some disk space
brew install mactex-no-gui

brew install --cask basictex

sudo tlmgr update --self
sudo tlmgr install moderncv fontawesome5 collection-fontsrecommended

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

Verifique que XeTeX foi instalado corretamente:

$ 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 2.11.1
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 é um motor moderno, completo e auto-contido de TeX/LaTeX, impulsionado por XeTeX e TeXLive.

Uma distribuição completa do TeX Live tipicamente ocupa vários GB de espaço em disco, enquanto a instalação inicial do tectonic ocupa apenas 10+ MB. Descarrega automaticamente os ficheiros de suporte, por isso não tem de instalar uma distribuição completa de LaTeX. Quando começa a usar um novo pacote de LaTeX, o Tectonic simplesmente baixa os ficheiros de que precisa e continua a processar.

O Tectonic fornece um guia de instalação oficial, mas isso simplesmente colocaria o tectonic no diretório onde executou o comando de instalação, o yamlresume precisa de um comando tectonic global no seu $PATH, então precisa de resolver isso com alguns truques de shell por sua conta.

Se é utilizador de macOS, tem sorte porque o Homebrew fornece um pacote pré-construído:

brew install tectonic

Na minha experiência, o tectonic ainda tem alguns problemas menores de compatibilidade com o XeTeX oficial, então se não se importam com o longo tempo de descarga de uma distribuição completa do TeX Live, o XeTeX continua a ser a opção recomendada aqui.

Fonte

Linux Libertine

O YAMLResume adota Linux Libertine como a fonte predefinida para caracteres latinos. É altamente recomendado instalá-la para obter uma saída PDF ótima.

brew install font-linux-libertine

sudo apt install fonts-linuxlibertine

sudo dnf install linux-libertine-fonts

Google Noto

Se precisar de currículos em CJK, também precisará de instalar fontes Google Noto para melhor cobertura 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

Resolução de Problemas

Pode abrir um problema se tiver problemas para instalar o yamlresume ou as suas dependências.

Pode ativar o registo detalhado passando uma flag --verbose ao yamlresume ou aos seus subcomandos.

Cansado?

Se estiver cansado do processo de instalação, pode experimentar o PPResume, que é uma solução de construção de currículos comercial e alojada que tornou o YAMLResume em código aberto.