YAML Schema Reference
このページでは resume.yaml で利用可能なすべてのフィールドを説明します。ファイルは JSON Schema に基づいてバリデーションされます。
トップレベル構造
personalInfo: # 必須 — 基本情報
sections: # 順序付きセクション配列(配列順 = レンダリング順) personalInfo — 基本情報
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
name | string | はい | 氏名 |
title | string | いいえ | 職種・肩書き |
email | string | いいえ | メールアドレス |
phone | string | いいえ | 電話番号 |
location | string | いいえ | 所在地(例:「東京, 日本」) |
links | array | いいえ | リンクリスト(各項目に label と url) |
Section Types — セクションタイプ
sections 配列の各セクションは type フィールドで構造とレンダリングが決まります。配列順でレンダリングされるため、順序を自由に変更してレイアウトをカスタマイズできます。
type: summary — 自己紹介
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
type | "summary" | はい | |
title | string | いいえ | 見出しの上書き(デフォルト: "Summary") |
tagline | string | いいえ | 短いサブタイトル |
content | string | はい | 自己紹介文(Markdown 対応) |
type: experience — 職歴
各 items の項目:
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
position | string | はい | 役職 |
organization | string | いいえ | 会社、コミュニティ、またはプロジェクト名 |
location | string | いいえ | 勤務地 |
startDate | date | はい | 入社日 |
endDate | date | null | いいえ | 退社日(省略で在職中) |
description | string | いいえ | 業務内容と実績(Markdown 対応) |
type: education — 学歴
各 items の項目:
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
institution | string | はい | 学校名 |
degree | string | はい | 学位・専攻 |
location | string | いいえ | 所在地 |
startDate | date | いいえ | 入学日 |
endDate | date | null | いいえ | 卒業日 |
description | string | いいえ | 関連科目、受賞歴など |
type: skills — スキル
各 items の項目:
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
category | string | はい | カテゴリ名(例:「プログラミング言語」「フレームワーク」) |
items | string[] | はい | スキルリスト |
type: generic — 汎用構造化セクション
プロジェクト、資格、受賞歴などの構造化コンテンツに適しています。title 必須。
各 items の項目:
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
title | string | はい | 項目タイトル |
subtitle | string | いいえ | サブタイトルまたは発行元 |
url | string | いいえ | リンク URL |
startDate | date | いいえ | 開始日 |
endDate | date | null | いいえ | 終了日 |
description | string | いいえ | 補足説明(Markdown 対応) |
type: list — リスト
論文、語学力、コミュニティの役割などのシンプルなリストに適しています。title 必須。
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
items | string[] | はい | 項目リスト(各項目 Markdown 対応) |
日付フォーマット
すべての日付フィールドは 3 つの形式を受け付けます:
YYYY— 年のみ(例:"2024")YYYY-MM— 年月(例:"2024-03")YYYY-MM-DD— 完全な日付(例:"2024-03-15")
重要:YAML では日付を必ず引用符で囲んでください。数値として解析されるのを防ぎます。
Markdown サポート
以下のフィールドは Markdown 構文をサポートしています:
summary.contentexperience[].descriptiongeneric[].descriptionlist[].items
サポートされる構文:**太字**、*斜体*、`インラインコード`、[リンク](URL)、- リスト
YAML 記述のヒント
|(リテラルブロック)で複数行テキストを記述(改行を保持)>-(フォールドブロック)で複数行を 1 行に結合(長い段落に最適)- コロン
:や特殊文字を含む文字列は引用符で囲む #でコメントを追加
完全な例
resume-template で完全な resume.yaml のサンプルファイルを確認できます。