Instalasi

YAMLResume adalah alat Node.js, di baliknya, ini mengubah resume Anda dari format YAML ke kode LaTeX dan kemudian memanggil mesin typesetting LaTeX untuk mengompilasi kode LaTeX yang dihasilkan ke PDF. Selain itu, untuk mendapatkan output PDF yang optimal, kami juga menyarankan untuk menginstal beberapa font. Singkatnya, Anda perlu menginstal hal-hal berikut untuk memulai dengan YAMLResume:

• Node.js
• paket yamlresume
• mesin typesetting
• [opsional] beberapa font

Kedengarannya sedikit rumit, tapi jangan khawatir, kami siap membantu Anda.

Pengguna Docker

Jika Anda pengguna docker, Anda beruntung, kami memiliki image docker untuk Anda. Image ini memiliki semuanya sudah dikemas, termasuk:

• Node.js
• yamlresume CLI
• XeTeX
• beberapa font yang direkomendasikan

Anda dapat membuat resume baru secara instan dengan perintah berikut:

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

Edit my-resume.yml sesuai kebutuhan lalu build resume dari yaml ke pdf:

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

Pada dasarnya, Anda dapat memanggil semua sub-command yamlresume CLI dengan cara ini—cukup tambahkan sub-command setelah yamlresume/yamlresume lalu ikuti panduan penggunaan yang sesuai.

Flag -v di sini cukup penting karena mount direktori saat ini ($(pwd)) ke container di /home/yamlresume, memungkinkan sinkronisasi file dua arah antara direktori lokal dan container.

docker pull ghcr.io/yamlresume/yamlresume

Masalah Izin

Terkadang Anda mungkin mengalami masalah izin saat menjalankan container Docker karena image yamlresume/yamlresume dibangun dengan instruksi USER yamlresume, yang secara default berjalan dengan lebih sedikit hak istimewa.

Ada dua cara untuk menyelesaikan masalah ini:

1. Gunakan username/group ID host Anda untuk menjalankan container:

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

Ini adalah cara yang direkomendasikan untuk menjalankan container. Selama pengguna host Anda memiliki akses ke direktori saat ini, Anda dapat menjalankan container dengan username/group ID host Anda.

2. Gunakan -u root untuk menjalankan container dengan akses root:

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

Ini adalah cara yang paling tidak direkomendasikan untuk menjalankan container. Ini tidak direkomendasikan karena dapat menyebabkan masalah keamanan, jadi Anda hanya boleh melakukan ini jika Anda yakin dengan apa yang Anda lakukan.

Terakhir tetapi tidak kalah penting, jika Anda menjalankan container yamlresume Docker di GitHub Actions, akses root mungkin diperlukan sesuai dengan dokumentasi GitHub:

Catatan: GitHub Actions harus dijalankan oleh pengguna Docker default (root). Pastikan Dockerfile Anda tidak menyetel instruksi USER, jika tidak Anda tidak akan dapat mengakses GITHUB_WORKSPACE.

Ref: Memahami Instruksi USER Docker

Pengguna Non-Docker

Jika Anda bukan pengguna docker, silakan ikuti petunjuk yang sesuai di bawah ini untuk menginstal yamlresume CLI dan semua dependensi yang diperlukan berdasarkan sistem operasi Anda. Pada saat penulisan, panduan kami mencakup macOS, Windows, dan beberapa distro Linux (Ubuntu dan distro berbasis RHEL).

Node.js

Node.js 20.x atau yang lebih baru diperlukan.

Mungkin ada lebih dari 100+ metode untuk menginstal Node.js pada OS yang berbeda, Anda dapat melihat Unduhan Node.js resmi untuk memulai.

Kami merekomendasikan menggunakan package manager untuk menginstal Node.js.

brew install node

choco install nodejs.install

sudo apt install nodejs

sudo dnf install nodejs

YAMLResume CLI

Menginstal yamlresume sangat mudah. Anda dapat menginstalnya menggunakan manajer paket Node.js favorit Anda:

npm install -g yamlresume

pnpm add -g yamlresume

yarn global add yamlresume

bun add -g yamlresume

Jika Anda pengguna macOS dan menggunakan Homebrew, Anda juga dapat menginstal yamlresume melalui Homebrew:

brew install yamlresume

Verifikasi bahwa yamlresume berhasil terinstal:

$ 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

Jika Anda hanya ingin mencoba yamlresume tanpa menginstalnya, Anda dapat menggunakan npx, pnpx atau alat serupa lainnya:

npx yamlresume help

yarn dlx yamlresume help

pnpx yamlresume help

bun exec yamlresume help

Mesin Typesetting

Di balik layar, yamlresume melakukan pekerjaan sebagai kompiler, mengurai resume YAML ke AST dan kemudian mentransformasi AST ke kode LaTeX.

Sebagai kompiler mini, yamlresume bergantung pada mesin typesetting untuk mengompilasi kode LaTeX yang dihasilkan ke PDF. Oleh karena itu, Anda harus terlebih dahulu menginstal mesin typesetting sebelum Anda dapat menggunakan yamlresume untuk menghasilkan resume PDF.

YAMLResume saat ini mendukung dua mesin typesetting: XeTeX dan Tectonic.

XeTeX

XeTeX adalah mesin typesetting TeX menggunakan Unicode dan mendukung teknologi font modern seperti OpenType, Graphite dan Apple Advanced Typography (AAT).

Ini adalah mesin typesetting yang sangat matang dan stabil yang banyak digunakan oleh banyak orang akademis dan ilmiah.

# 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

Verifikasi bahwa XeTeX berhasil terinstal:

$ 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
pplib version v2.05 less toxic i hope
Using Mac OS X Core Text and Cocoa frameworks

Tectonic

Tectonic adalah mesin TeX/LaTeX yang dimodenkan, lengkap, dan mandiri, didukung oleh XeTeX dan TeXLive.

Distribusi TeX Live lengkap biasanya membutuhkan ruang disk beberapa GB, sementara instalasi awal tectonic hanya membutuhkan 10+ MB. Ini secara otomatis mengunduh file dukungan, jadi Anda tidak perlu menginstal distribusi LaTeX lengkap. Saat Anda mulai menggunakan paket LaTeX baru, Tectonic cukup mengunduh file yang dibutuhkan dan melanjutkan pemrosesan.

Tectonic menyediakan panduan instalasi resmi, tetapi ini akan menempatkan tectonic di direktori tempat Anda menjalankan perintah instalasi, yamlresume membutuhkan perintah tectonic global di $PATH Anda, jadi Anda perlu mencari tahu itu dengan beberapa hacks shell sendiri.

Jika Anda pengguna macOS, Anda ber karena Homebrew menyediakan paket prebuilt:

brew install tectonic

Berdasarkan pengalaman saya, tectonic masih memiliki beberapa masalah kompatibilitas minor dengan XeTeX resmi, jadi jika Anda tidak介意 dengan waktu unduh lama dari distribusi TeX Live lengkap, XeTeX masih menjadi pilihan yang direkomendasikan di sini.

Font

Linux Libertine

YAMLResume mengadopsi Linux Libertine sebagai font default untuk karakter Latin. Sangat disarankan untuk menginstalnya untuk mendapatkan output PDF yang optimal.

brew install font-linux-libertine

sudo apt install fonts-linuxlibertine

sudo dnf install linux-libertine-fonts

Google Noto

Jika Anda membutuhkan resume CJK, Anda juga perlu menginstal font Google Noto untuk cakupan unicode terbaik.

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

Pemecahan Masalah

Anda dapat mengirim issue jika Anda kesulitan menginstal yamlresume atau dependensinya.

Anda dapat mengaktifkan logging verbose dengan memberikan flag --verbose ke yamlresume atau subcommandnya.

Lelah?

Jika Anda lelah dengan proses instalasi, Anda dapat mencoba PPResume, yang merupakan solusi builder resume komersial yang di-hosting yang membuka sumber YAMLResume.