YAML Schema Reference

本页说明 resume.yaml 中所有可用字段。你的文件会依据我们的 JSON Schema 进行验证。

顶层结构

personalInfo:   # 必填 — 个人基本资料
sections:       # 有序区块数组(数组顺序 = 渲染顺序)

personalInfo — 个人资料

字段类型必填说明
namestring全名
titlestring职称或标题
emailstring电子邮箱
phonestring电话号码
locationstring所在地,例如「北京, 中国」
linksarray链接列表,每项包含 labelurl

Section Types — 区块类型

sections 数组中每个区块都有 type 字段决定结构与排版。区块按数组顺序渲染 — 自由调整顺序即可定制版面。

type: summary — 自我介绍

字段类型必填说明
type"summary"
titlestring覆盖标题(默认 "Summary")
taglinestring简短副标题
contentstring自我介绍内容(支持 Markdown)

type: experience — 工作经历

每个 items 项目:

字段类型必填说明
positionstring职位名称
organizationstring公司、社区或项目名称
locationstring工作地点
startDatedate入职日期
endDatedate | null离职日期(省略代表在职中)
descriptionstring工作内容与成就(支持 Markdown)

type: education — 学历

每个 items 项目:

字段类型必填说明
institutionstring学校名称
degreestring学位与专业
locationstring学校所在地
startDatedate入学日期
endDatedate | null毕业日期
descriptionstring相关课程、荣誉等

type: skills — 技能

每个 items 项目:

字段类型必填说明
categorystring技能分类名称(如「编程语言」「框架」)
itemsstring[]技能列表

type: generic — 通用结构化区块

适合项目、证书、奖项等结构化内容。title 必填。

每个 items 项目:

字段类型必填说明
titlestring项目标题
subtitlestring副标题或发行单位
urlstring链接
startDatedate开始日期
endDatedate | null结束日期
descriptionstring补充说明(支持 Markdown)

type: list — 纯列表

适合论文、语言能力、社区角色等简单列表。title 必填。

字段类型必填说明
itemsstring[]项目列表(每项支持 Markdown)

日期格式

所有日期字段接受三种格式:

  • YYYY — 仅年份(如 "2024"
  • YYYY-MM — 年月(如 "2024-03"
  • YYYY-MM-DD — 完整日期(如 "2024-03-15"

重要:在 YAML 中,日期务必用引号包裹,避免被解析为数字。

Markdown 支持

以下字段支持 Markdown 语法:

  • summary.content
  • experience[].description
  • generic[].description
  • list[].items

支持的语法:**粗体***斜体*`行内代码`[链接](URL)- 列表

YAML 编写提示

  • 使用 |(literal block)编写多行文字,保留换行符号
  • 使用 >-(folded block)将多行文字合并为一行,适合长段落
  • 包含冒号 : 或特殊字符的字符串需用引号包裹
  • 使用 # 加上注释

完整示例

参考我们的 resume-template 获取完整的 resume.yaml 示例文件。