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 | 否 | 链接 |
startDate | date | 否 | 开始日期 |
endDate | date | null | 否 | 结束日期 |
description | string | 否 | 补充说明(支持 Markdown) |
type: list — 纯列表
适合论文、语言能力、社区角色等简单列表。title 必填。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
items | string[] | 是 | 项目列表(每项支持 Markdown) |
日期格式
所有日期字段接受三种格式:
YYYY— 仅年份(如"2024")YYYY-MM— 年月(如"2024-03")YYYY-MM-DD— 完整日期(如"2024-03-15")
重要:在 YAML 中,日期务必用引号包裹,避免被解析为数字。
Markdown 支持
以下字段支持 Markdown 语法:
summary.contentexperience[].descriptiongeneric[].descriptionlist[].items
支持的语法:**粗体**、*斜体*、`行内代码`、[链接](URL)、- 列表
YAML 编写提示
- 使用
|(literal block)编写多行文字,保留换行符号 - 使用
>-(folded block)将多行文字合并为一行,适合长段落 - 包含冒号
:或特殊字符的字符串需用引号包裹 - 使用
#加上注释
完整示例
参考我们的 resume-template 获取完整的 resume.yaml 示例文件。