インストール

YAMLResume は Node.js ツールで、内部では YAML 形式の履歴書を LaTeX コードに変換し、LaTeX タイプセッティングエンジンを呼び出して生成された LaTeX コードを PDF にコンパイルします。また、最適な PDF 出力を得るために、いくつかのフォントのインストールも推奨しています。要するに、YAMLResume を始めるには以下をインストールする必要があります：

• Node.js
• yamlresume パッケージ
• タイプセッティングエンジン
• [オプション] いくつかのフォント

これは少し複雑に聞こえますが、心配ありません。私たちがサポートします。

Docker ユーザー

Docker ユーザーの場合、Docker イメージ をご用意しており、すべてが事前にパッケージ化されています：

• Node.js
• yamlresume CLI
• XeTeX
• 推奨フォント

以下のコマンドで新しい履歴書を即座に作成できます：

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

編集後、yaml から pdf に履歴書をビルドします：

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

基本的に、この方法で yamlresume CLI サブコマンド をすべて呼び出すことができます—yamlresume/yamlresume の後にサブコマンドを追加し、対応する使用ガイドに従うだけです。

-v フラグは非常に重要です。現在のディレクトリ（$(pwd)）をコンテナ内の /home/yamlresume にマウントし、ローカルディレクトリとコンテナ間の双方向ファイル同期を可能にします。

docker pull ghcr.io/yamlresume/yamlresume

権限の問題

Docker コンテナを実行する際に権限の問題 が発生する場合があります。これは yamlresume/yamlresume イメージが USER yamlresume ディレクティブで構築されており、デフォルトでより少ない権限で実行されるためです。

この問題を解決するには 2 つの方法があります：

1. ホストのユーザー名/グループ ID を使用してコンテナを実行：

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

これはコンテナを実行する推奨方法です。ホストユーザーが現在のディレクトリにアクセスする権限がある限り、ホストのユーザー名/グループ ID でコンテナを実行できます。

2. -u root を使用して root アクセス権限でコンテナを実行：

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

これはコンテナを実行する最も推奨されない方法です。セキュリティ上の問題を引き起こす可能性があるため推奨されません。何をしているか確信がある場合のみ実行してください。

最後に、GitHub Actions で yamlresume Docker コンテナを実行する場合、GitHub のドキュメント によると、root アクセス権限が必要な場合があります：

注意：GitHub Actions はデフォルトの Docker ユーザー（root）で実行する必要があります。Dockerfile で USER ディレクティブを設定しないでください。そうしないと GITHUB_WORKSPACE にアクセスできません。

参照：Understanding the Docker USER Instruction

非 Docker ユーザー

Docker ユーザーでない場合は、以下の適切な説明に従って、オペレーティングシステムに応じて yamlresume CLI とすべての必要な依存関係をインストールしてください。この記事を書いている時点で、私たちのガイドは macOS、Windows、およびいくつかの Linux ディストリビューション（Ubuntu と RHEL ベースのディストリビューション）をカバーしています。

Node.js

Node.js 20.x または更新バージョンが必要です。

異なるオペレーティングシステムで Node.js をインストールする方法は 100 以上あります。開始するには、公式の Node.js ダウンロード をご確認ください。

Node.js のインストールにはパッケージマネージャー の使用を推奨します。

brew install node

choco install nodejs.install

sudo apt install nodejs

sudo dnf install nodejs

YAMLResume CLI

yamlresume のインストールは非常に簡単です。お好みの Node.js パッケージマネージャーを使用してインストールできます：

npm install -g yamlresume

pnpm add -g yamlresume

yarn global add yamlresume

bun add -g yamlresume

yamlresume が正常にインストールされたことを確認：

$ 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

yamlresume をインストールせずに試したい場合は、 npx、pnpx またはその他の類似ツールを使用できます：

npx yamlresume help

yarn dlx yamlresume help

pnpx yamlresume help

bun exec yamlresume help

タイプセッティングエンジン

内部的には、yamlresume はコンパイラの作業を完了し、YAML 履歴書を AST に解析し、その後 AST を LaTeX コードに変換 します。

小型コンパイラとして、yamlresume は生成された LaTeX コードを PDF にコンパイルするためにタイプセッティングエンジンに依存します。したがって、yamlresume を使用して履歴書 PDF を生成する前に、まずタイプセッティングエンジンをインストールする必要があります。

YAMLResume は現在 2 つのタイプセッティングエンジンをサポートしています：XeTeX と Tectonic。

XeTeX

XeTeX は Unicode を使用し、OpenType、Graphite、Apple Advanced Typography (AAT) などの現代フォント技術をサポートする TeX タイプセッティングエンジンです。

多くの学術・科学関係者に広く使用されている、非常に成熟した安定したタイプセッティングエンジンです。

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

XeTeX が正常にインストールされたことを確認：

$ 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 は、XeTeX と TeXLive によってサポートされる、モダンで完全で自己完結型の TeX/LaTeX エンジンです。

完全な TeX Live ディストリビューションは通常数 GB のディスク容量を占有しますが、tectonic の初期インストールは 10+ MB しか占有しません。サポートファイルを自動的にダウンロードするため、完全な LaTeX ディストリビューションをインストールする必要はありません。新しい LaTeX パッケージの使用を開始すると、Tectonic は必要なファイルのみをダウンロードして処理を続行します。

Tectonic は公式インストールガイド を提供していますが、これは tectonic をインストールコマンドを実行したディレクトリに配置するだけで、yamlresume は $PATH にグローバルな tectonic コマンドが必要なため、シェルのトリックを使用して自分で解決する必要があります。

macOS ユーザーの場合、Homebrew がプリビルドパッケージを提供しているため幸運です：

brew install tectonic

私の経験では、tectonic と公式 XeTeX の間にはまだいくつかの小さな互換性の問題があるため、完全な TeX Live ディストリビューションの長いダウンロード時間を気にしない場合は、XeTeX がここでの推奨選択肢です。

フォント

Linux Libertine

YAMLResume は、ラテン文字のデフォルトフォントとして Linux Libertine を採用しています。最適な PDF 出力を得るために、インストールを強く推奨します。

brew install font-linux-libertine

sudo apt install fonts-linuxlibertine

sudo dnf install linux-libertine-fonts

Google Noto

CJK 履歴書が必要な場合、最適な unicode カバレッジ を得るために Google Noto フォント もインストールする必要があります。

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

トラブルシューティング

yamlresume またはその依存関係のインストールで問題が発生した場合は、問題を報告 してください。

yamlresume またはそのサブコマンドに --verbose フラグを渡すことで、詳細ログを有効にできます。

疲れましたか？

インストールプロセスに疲れた場合は、PPResume を試すことができます。これは YAMLResume をオープンソース化したホスト型商用履歴書ビルダーソリューションです。