@sugitlab/resumake
v1.1.3
Published
Generate beautiful PDF resumes from Markdown
Readme
resumake
resume.md を読み込み、美しい職務経歴書 PDF を生成する Node.js CLI ツール。
必要環境
- Node.js 18 以上
インストール
npm install -g @sugitlab/resumakeまたはインストールなしで直接実行:
npx @sugitlab/resumake使い方
1. resume.md を用意する
カレントディレクトリに resume.md を配置します。
---
title: 履歴書・職務経歴書
name: 山田 太郎
furigana: やまだ たろう
englishName: Taro Yamada
photo: ./photo.jpg
updatedAt: 2026年4月30日
birthDate: 1996年4月1日
age: 30
address: 〒100-0001 東京都千代田区千代田1-1
phone: 090-1234-5678
email: [email protected]
---
## 職務要約
Webアプリケーション開発を中心に5年間のエンジニア経験。
## 職務経歴
```timeline
2019年4月〜2021年3月 | 株式会社Sample | フロントエンドエンジニア | Vue.jsを用いた管理画面の開発
2021年4月〜現在 | 株式会社Example | ソフトウェアエンジニア | React / TypeScript を用いた SPA の設計・開発
```
## スキル
| カテゴリ | 技術 |
|------|------|
| 言語 | TypeScript, JavaScript, Python |
| フロントエンド | React, Vue.js, Next.js |
## リンク
- [ポートフォリオ](https://example.com)
- [GitHub](https://github.com/example)
## 学歴
```timeline
2015年4月 | ○○大学 情報工学部 | 入学
2019年3月 | ○○大学 情報工学部 | 卒業
```resume.md の先頭に frontmatter を書くと、PDF の冒頭に履歴書形式の基本情報欄が表組みでレンダリングされます。
| キー | 表示項目 | 例 |
|---|---|---|
| title | 冒頭タイトル | 履歴書・職務経歴書 |
| name | 氏名 | 山田 太郎 |
| furigana | ふりがな | やまだ たろう |
| englishName | 英字名 | Taro Yamada |
| photo | 顔写真 | ./photo.jpg |
| updatedAt | 更新日 | 2026年4月30日 |
| birthDate | 生年月日 | 1996年4月1日 |
| age | 満年齢 | 30 |
| address | 現住所 | 〒100-0001 東京都千代田区千代田1-1 |
| phone | 電話番号 | 090-1234-5678 |
| email | メールアドレス | [email protected] |
職歴や学歴を時系列表示したい場合は、timeline コードフェンスを使います。各行は 年月 | タイトル | 補足 | 説明 の順で書き、補足と説明は省略できます。
```timeline
2019年4月〜2021年3月 | 株式会社Sample | フロントエンドエンジニア | Vue.jsを用いた管理画面の開発
2021年4月〜現在 | 株式会社Example | ソフトウェアエンジニア | React / TypeScript を用いた SPA の設計・開発
```Markdownのリンクは青色・下線付きで表示されます。http:// または https:// の外部リンクには文末に外部リンクアイコンが付きます。
## リンク
- [ポートフォリオ](https://example.com)
- [GitHub](https://github.com/example)2. PDF を生成する
npx @sugitlab/resumakeカレントディレクトリの resume.md を読み込み、resume.pdf が生成されます。
Markdownファイルを指定する場合:
npx @sugitlab/resumake docs/resume-ja.md出力先を指定する場合:
npx @sugitlab/resumake docs/resume-ja.md --output dist/resume.pdfヘルプを表示する場合:
npx @sugitlab/resumake --helpサンプルMarkdownを生成する場合:
npx @sugitlab/resumake --init実行したディレクトリに resume-sample.md が生成されます。既に同名ファイルがある場合は上書きせずに終了します。
カラーテーマ
--theme <name> フラグでテーマを指定できます。
npx @sugitlab/resumake --theme asagi短いオプション名も使えます。
npx @sugitlab/resumake resume.md -t asagi -o resume-asagi.pdf| テーマ名 | イメージ | 出力ファイル名 |
|---|---|---|
| (なし) | モノクロ・ATS対応 | resume.pdf |
| asagi | 浅葱(青緑) | resume-asagi.pdf |
| sakura | 桜(ピンク) | resume-sakura.pdf |
| wakakusa | 若草(緑) | resume-wakakusa.pdf |
| fuji | 藤(紫) | resume-fuji.pdf |
| kohaku | 琥珀(金茶) | resume-kohaku.pdf |
全テーマを一括生成する例
for theme in asagi sakura wakakusa fuji kohaku; do
npx @sugitlab/resumake --theme $theme
donePDF の仕様
- 用紙: A4
- 余白: 上下 20mm・左右 18mm
- フォント: Noto Sans JP(Google Fonts)
- デフォルト: モノクロ・ATS スキャン対応レイアウト
- ヘッダー: frontmatter の
updatedAtを右上に表示 - フッター: 中央にページ番号を表示
エラーメッセージ
| メッセージ | 原因と対処 |
|---|---|
| Error: resume.md が見つかりません。 | カレントディレクトリに resume.md がない。ファイルを配置してから再実行。 |
| Error: 不明なテーマ "xxx" が指定されました。 | --theme に存在しないテーマ名を指定した。使用可能なテーマ名を確認して再実行。 |
ライセンス
MIT
