YAMLResume
コンパイラ

タイプ

この文書は、YAMLResume 履歴書構造を定義する TypeScript タイプの概要を提供します。TypeScript プロジェクトとして、YAMLResume はデータの一貫性を確保するために静的タイプを採用しています。このファイルは、個人詳細、教育、経験、スキルなどを含む、履歴書情報を表現するために使用されるコアデータ構造の概要を提供します。

詳細については、実際のソース types/index.ts をご確認ください。

これらのタイプを理解することは、YAMLResume の機能をカスタマイズまたは拡張したい貢献者や開発者にとって重要です。

この文書は、有効な YAMLResume を作成しようとするユーザーに権威ある参照を提供し、オプションと必須フィールドの違いを明確にします。YAMLResume で正常にコンパイルするために、最小履歴書には以下の基本フィールドが含まれている必要があります：

  • content.basics.name
  • education[number].area
  • education[number].degree
  • education[number].institution
  • education[number].startDate

したがって、理論的には最小実行可能履歴書は以下のようになります：

content:
  basics:
    name: Xiao Hanyu
  education:
    - area: Computer Science and Technology
      degree: Bachelor
      institution: Zhejiang University
      startDate: Sep, 2007

Resume

全体的な履歴書構造を定義し、コンテンツとレイアウトを含みます。

属性タイプ必須説明
contentContent✅履歴書全体のコンテンツ構造を定義します。
layouts?Layouts⬜全体的なレイアウト設定を定義します。
locale?Locale⬜全体的なロケール設定を定義します。

以下は履歴書構造の高レベル図です：

Content

履歴書全体のコンテンツ構造を定義します。

属性タイプ必須説明
basicsBasicsItem✅コア個人情報と連絡先情報を表します。
educationEducationItem[]✅教育経験のコレクションを含みます。
awards?AwardItem[]⬜賞と認識のコレクションを含みます。
certificates?CertificateItem[]⬜認証と証明書のコレクションを含みます。
interests?InterestItem[]⬜興味、趣味、または個人的な活動のコレクションを含みます。
languages?LanguageItem[]⬜言語能力のコレクションを含みます。
location?LocationItem⬜位置情報を含みます。
projects?ProjectItem[]⬜プロジェクトのコレクションを含みます。
profiles?ProfileItem[]⬜オンラインプロフィールのコレクションを含みます。
publications?PublicationItem[]⬜出版物のコレクションを含みます。
references?ReferenceItem[]⬜推薦人のコレクションを含みます。
skills?SkillItem[]⬜スキルのコレクションを含みます。
volunteer?VolunteerItem[]⬜ボランティア経験のコレクションを含みます。
work?WorkItem[]⬜職歴と雇用履歴のコレクションを含みます。

AwardItem

獲得した単一の賞、名誉、または認識を表します。

属性タイプ必須説明
awarderstring✅賞を授与した組織または団体。
titlestring✅賞の名前またはタイトル。
date?string⬜受賞日（例：「2020」、「Oct 2020」）。
summary?string⬜賞に関する短い説明または詳細情報。

BasicsItem

コア個人情報と連絡先情報を表します。

属性タイプ必須説明
namestring✅フルネーム。
email?string⬜メールアドレス。
headline?string⬜短い専門タイトルまたは役職（例：「ソフトウェアエンジニア」）。
phone?string⬜電話番号。
summary?string⬜専門的な要約または目標声明。
url?string⬜個人ウェブサイトまたはポートフォリオ URL。

CertificateItem

単一の認証、証明書、または専門資格を表します。

属性タイプ必須説明
issuerstring✅証明書を発行した組織。
namestring✅証明書名。
date?string⬜証明書取得日（例：「2021」、「Nov 2021」）。
url?string⬜証明書に関連する URL（例：検証リンク）。

EducationItem

単一の教育経験または学位プログラムを表します。

属性タイプ必須説明
areastring✅研究分野（例：「コンピュータサイエンス」）。
degreeDegree✅取得した学位タイプ。
institutionstring✅機関名。
startDatestring✅学習開始日（例：「2016」、「Sep 2016」）。
courses?string[]⬜受講したコースのリスト。
endDate?string⬜学習終了日（例：「2020」、「May 2020」）、空値は「現在」を表します。
summary?string⬜成果または詳細情報の説明。
score?string⬜GPA または学業成績。
url?string⬜機関または学位に関連する URL。

InterestItem

単一の興味、趣味、または個人的な活動を表します。

属性タイプ必須説明
namestring✅興味カテゴリ名（例：「読書」、「写真」）。
keywords?string[]⬜興味に関連するキーワード。

LanguageItem

単一の言語能力項目を表します。

属性タイプ必須説明
fluencyFluency✅言語の流暢度。
languageLanguage✅言語。
keywords?string[]⬜言語スキルに関連する特定のキーワード（例：「翻訳」）。

LocationItem

位置と住所情報を表します。

属性タイプ必須説明
citystring✅都市名。
address?string⬜住所。
country?Country⬜国コードまたは国名。
postalCode?string⬜郵便番号。
region?string⬜州、省、または地域。

ProfileItem

単一のオンラインプロフィールまたはソーシャルメディアの存在を表します。

属性タイプ必須説明
networkNetwork✅ネットワークまたはプラットフォーム名。
usernamestring✅プラットフォーム上のユーザー名。
url?string⬜プロフィールの URL。

ProjectItem

単一のプロジェクト、ポートフォリオ作品、または技術的な作業を表します。

属性タイプ必須説明
namestring✅プロジェクト名。
startDatestring✅プロジェクト開始日（例：「2021」、「Jan 2021」）。
summarystring✅プロジェクトの詳細な成果。
description?string⬜プロジェクトの説明。
endDate?string⬜プロジェクト終了日（例：「2022」、「Jul 2022」）。
keywords?string[]⬜プロジェクトで使用されたキーワードまたは技術。
url?string⬜プロジェクトに関連する URL（例：リポジトリ、ライブデモ）。

PublicationItem

単一の出版物、研究作業、または学術論文を表します。

属性タイプ必須説明
namestring✅出版物の名前またはタイトル。
publisherstring✅作品の出版社。
releaseDate?string⬜発行日（例：「2023」、「Mar 2023」）。
summary?string⬜出版物の要約または概要。
url?string⬜出版物に関連する URL（例：DOI、リンク）。

ReferenceItem

単一の専門推薦人または推薦を表します。

属性タイプ必須説明
namestring✅推薦人の名前。
summarystring✅推薦人に関する短い説明。
email?string⬜推薦人のメールアドレス。
phone?string⬜推薦人の電話番号。
relationship?string⬜推薦人との関係（例：「元マネージャー」）。

SkillItem

単一のスキル、能力、または技術的能力を表します。

属性タイプ必須説明
levelLevel✅スキルの習熟度。
namestring✅スキル名。
keywords?string[]⬜スキルに関連する特定のキーワードまたは技術。

VolunteerItem

単一のボランティア経験またはコミュニティサービスを表します。

属性タイプ必須説明
organizationstring✅組織名。
positionstring✅担当した役割または職位。
startDatestring✅ボランティア活動開始日（例：「2019」、「Jun 2019」）。
summarystring✅責任または成果の要約。
endDate?string⬜ボランティア活動終了日（例：「2020」、「Dec 2020」）。
url?string⬜組織または活動に関連する URL。

WorkItem

単一の職歴または雇用職位を表します。

属性タイプ必須説明
namestring✅会社または雇用主名。
positionstring✅職位または担当した役職。
startDatestring✅雇用開始日（例：「2021」、「Apr 2021」）。
summarystring✅責任と成果の要約。
endDate?string⬜雇用終了日（例：「2023」、「Aug 2023」）。
keywords?string[]⬜役職または使用技術に関連するキーワード。
url?string⬜会社または職務に関連する URL。

Locale

国際化とローカライゼーションのロケール設定を定義します。

属性タイプ必須説明
language?LocaleLanguage⬜履歴書コンテンツとテンプレート用語の選択された言語。

Layouts

複数の出力形式をサポートするレイアウト項目の配列。

属性タイプ必須説明
layouts[]DocxLayout | HtmlLayout | LatexLayout | MarkdownLayout⬜複数の出力レイアウト設定。

一般的なレイアウトタイプ

Margins

文書レイアウトのマージン設定を定義します。

属性タイプ必須説明
top?string⬜上マージン値（例：「2.5cm」）。
bottom?string⬜下マージン値（例：「2.5cm」）。
left?string⬜左マージン値（例：「1.5cm」）。
right?string⬜右マージン値（例：「1.5cm」）。
Sections

セクション名をカスタマイズするためのセクションエイリアス設定を定義します。

属性タイプ必須説明
aliases?Record<SectionID, string>⬜デフォルトの翻訳を上書きする、セクション名のカスタムエイリアス。
order?OrderableSectionID[]⬜最終出力におけるセクションのカスタム順序。
Theme

セクションタイトル、罫線、リンク、ラベルなどのハイライト要素に使用する アクセントカラーを含む、履歴書のビジュアルテーマ設定を定義します。 markdown エンジンはテーマオプションを無視します。

属性タイプ必須説明
colors?{ accent?: AccentColor | HexColor }⬜テーマのカラー設定を定義します。

colors.accent オプションは、セクションタイトル、罫線、リンク、 ラベルなどのハイライト要素に使用するアクセントカラーを設定します。 名前付きの AccentColor プリセット、または任意の #RRGGBB 形式の16進カラー文字列を指定できます。

HtmlLayout

HTML レイアウト設定。

属性タイプ必須説明
engine'html'✅履歴書を生成するエンジン。
advanced?HtmlAdvanced⬜高度なレイアウト設定オプションを定義します。
sections?Sections⬜セクションのカスタマイズ設定を定義します。
template?HtmlTemplate⬜選択されたテンプレートを定義します。
theme?Theme⬜履歴書のビジュアルテーマ設定を定義します。
typography?HtmlTypography⬜文書フォーマットのタイポグラフィ設定を定義します。
HtmlAdvanced

高度な HTML 設定オプションを定義します。

属性タイプ必須説明
showAnchors?boolean⬜セクションとエントリーにアンカーナビゲーション用のフラグメント id 属性を付与するかどうか（デフォルト: true）。
showIcons?boolean⬜リンクとプロフィールのアイコンを表示するかどうか。
title?string⬜HTML ドキュメントのカスタムタイトル。
footer?string⬜HTML ドキュメントのカスタムフッター。
description?string⬜HTML ドキュメントのメタ記述。
keywords?string⬜HTML ドキュメントのメタキーワード。
HtmlTypography

HTML 文書フォーマットのタイポグラフィ設定を定義します。

属性タイプ必須説明
fontFamily?string⬜使用するフォントファミリーのカンマ区切りリスト。
fontSize?HtmlFontSize⬜文書の基本フォントサイズ。
lineSpacing?LineSpacing⬜文書の行間。

LatexLayout

LaTeX レイアウト設定。

属性タイプ必須説明
advanced?LatexAdvanced⬜高度な設定オプションを定義します。
engine'latex'✅履歴書を生成するエンジン。
page?LatexPage⬜文書プレゼンテーションのページレベル設定を定義します。
sections?Sections⬜セクションのカスタマイズ設定を定義します。
template?LatexTemplate⬜選択されたテンプレートを定義します。
theme?Theme⬜履歴書のビジュアルテーマ設定を定義します。
typography?LatexTypography⬜文書フォーマットのタイポグラフィ設定を定義します。
LatexAdvanced

LaTeX の高度な設定オプションを定義します。

属性タイプ必須説明
fontspec?{ numbers?: LatexFontspecNumbers }⬜LaTeX fontspec パッケージ設定。
showIcons?boolean⬜リンクとプロフィールのアイコンを表示するかどうか。
showUrls?boolean⬜生の URL を表示するか、適切なテキストの背後に隠すか。
LatexPage

LaTeX の文書プレゼンテーションのページレベル設定を定義します。

属性タイプ必須説明
margins?Margins⬜ページマージン設定を定義します。
paperSize?PaperSize⬜用紙サイズを定義します。
showPageNumbers?boolean⬜ページ番号を表示するかどうか。
LatexTypography

LaTeX の文書フォーマットのタイポグラフィ設定を定義します。

属性タイプ必須説明
fontSize?LatexFontSize⬜文書の基本フォントサイズ。
fontFamily?string⬜使用するフォントファミリーのカンマ区切りリスト。
lineSpacing?LineSpacing⬜文書の行間。
links?{ underline?: boolean }⬜リンクのスタイル設定。

MarkdownLayout

Markdown レイアウト設定。

属性タイプ必須説明
engine'markdown'✅履歴書を生成するエンジン。
sections?Sections⬜セクションのカスタマイズ設定を定義します。

DocxLayout

DOCX レイアウト設定。

属性タイプ必須説明
engine'docx'✅履歴書を生成するエンジン。
advanced?DocxAdvanced⬜高度な設定オプションを定義します。
page?DocxPage⬜文書プレゼンテーションのページレベル設定を定義します。
sections?Sections⬜セクションのカスタマイズ設定を定義します。
template?DocxTemplate⬜選択されたテンプレートを定義します。
theme?Theme⬜履歴書のビジュアルテーマ設定を定義します。
typography?DocxTypography⬜文書フォーマットのタイポグラフィ設定を定義します。
DocxAdvanced

DOCX の高度な設定オプションを定義します。

属性タイプ必須説明
showIcons?boolean⬜リンクとプロフィールのアイコンを表示するかどうか。
showUrls?boolean⬜生の URL を表示するか、適切なテキストの背後に隠すか。
DocxPage

DOCX の文書プレゼンテーションのページレベル設定を定義します。

属性タイプ必須説明
margins?Margins⬜ページマージン設定を定義します。
paperSize?DocxPaperSize⬜用紙サイズを定義します。
showPageNumbers?boolean⬜ページ番号を表示するかどうか。
DocxTypography

DOCX の文書フォーマットのタイポグラフィ設定を定義します。

属性タイプ必須説明
fontSize?DocxFontSize⬜文書の基本フォントサイズ。
fontFamily?string⬜使用するフォントファミリーのカンマ区切りリスト。
lineSpacing?LineSpacing⬜文書の行間。

列挙タイプ

コンテンツ Enum

Country

世界のすべての可能な国と地域のユニオンタイプ。

Degree

すべての可能な学位のユニオンタイプ。

  • Associate
  • Bachelor
  • Diploma
  • Doctor
  • High School
  • Master
  • Middle School

Fluency

すべての可能な言語流暢度のユニオンタイプ。

  • Elementary Proficiency
  • Full Professional Proficiency
  • Limited Working Proficiency
  • Minimum Professional Proficiency
  • Native or Bilingual Proficiency

Language

すべてのサポートされている言語のユニオンタイプ。

Level

すべての可能なスキル習熟度のユニオンタイプ。

  • Advanced
  • Beginner
  • Expert
  • Intermediate
  • Master
  • Novice

Network

すべての可能なソーシャルネットワークオプションのユニオンタイプ。

レイアウト Enum

AccentColor

moderncv のカラースキームパレットに 従う、すべてのアクセントカラープリセットの共用体型です。 AccentColor が期待される任意の場所では、任意の #RRGGBB 形式の 16進カラー文字列も受け付けます。

  • black - #000000
  • blue - #3873B3
  • burgundy - #980000
  • cerulean - #0081A7
  • green - #59B24D
  • grey - #737373
  • orange - #F28C26
  • purple - #8054CC
  • red - #F23333

DocxFontSize

すべての可能な DOCX フォントサイズオプションのユニオンタイプ。

  • 10pt - 10pt フォントサイズ（デフォルト）
  • 10.5pt - 10.5pt フォントサイズ
  • 11pt - 11pt フォントサイズ
  • 11.5pt - 11.5pt フォントサイズ
  • 12pt - 12pt フォントサイズ

DocxPaperSize

すべての可能な DOCX 用紙サイズオプションのユニオンタイプ。

  • a4 (デフォルト)
  • letter

DocxTemplate

すべての可能な DOCX テンプレートオプションのユニオンタイプ。

参照：テンプレート

  • calm

HtmlFontSize

すべての可能な HTML フォントサイズオプションのユニオンタイプ。

HTML エンジンは 14px から 20px のサイズをサポートします：

  • 14px、15px、16px (デフォルト)、17px、18px、19px、20px

HtmlTemplate

すべての可能な HTML テンプレートオプションのユニオンタイプ。

参照：テンプレート

  • calm
  • kami
  • vscode

LatexFontSize

すべての可能な Latex フォントサイズオプションのユニオンタイプ。

現在 3 つのオプションのみサポート：

  • 10pt - 10pt フォントサイズ（デフォルト）
  • 11pt - 11pt フォントサイズ
  • 12pt - 12pt フォントサイズ

LineSpacing

すべての可能な行間オプションのユニオンタイプ。

これらのセマンティック値は Tailwind CSS のレディングスケールに従います：

  • tight - より多くのコンテンツを収めるためのコンパクトな間隔
  • snug - tight よりわずかに多いスペース
  • normal - バランス 取れた読みやすさ（デフォルト）
  • relaxed - 行間に更多のスペース
  • loose - 非常にゆったりとしたレイアウト

LatexFontspecNumbers

すべての可能な latex fontspec 数字オプションのユニオンタイプ。

  • Auto - 選択された LocaleLanguage に基づいてスタイルを自動決定することを許可（デフォルト）
  • Lining - 標準のライニング数字（CJK 言語のデフォルト）
  • OldStyle - 異なる高さのオールドスタイル数字（ラテン言語のデフォルト）

LatexTemplate

すべての可能なテンプレートオプションのユニオンタイプ。

参照：テンプレート

  • jake
  • moderncv-banking
  • moderncv-casual
  • moderncv-classic

PaperSize

すべての可能な LaTeX 用紙サイズオプションのユニオンタイプ。

  • a4 (デフォルト)
  • letter

ロケール Enum

LocaleLanguage

すべての可能なロケール言語のユニオンタイプ。

参照：多言語

  • en
  • es
  • zh-hans
  • zh-hant-hk
  • zh-hant-tw
Edit on GitHub

Last updated on

アーキテクチャ

Previous Page

スキーマ

Next Page

On this page

ResumeContentAwardItemBasicsItemCertificateItemEducationItemInterestItemLanguageItemLocationItemProfileItemProjectItemPublicationItemReferenceItemSkillItemVolunteerItemWorkItemLocaleLayouts一般的なレイアウトタイプMarginsSectionsThemeHtmlLayoutHtmlAdvancedHtmlTypographyLatexLayoutLatexAdvancedLatexPageLatexTypographyMarkdownLayoutDocxLayoutDocxAdvancedDocxPageDocxTypography列挙タイプコンテンツ EnumCountryDegreeFluencyLanguageLevelNetworkレイアウト EnumAccentColorDocxFontSizeDocxPaperSizeDocxTemplateHtmlFontSizeHtmlTemplateLatexFontSizeLineSpacingLatexFontspecNumbersLatexTemplatePaperSizeロケール EnumLocaleLanguage