YAML Schema Reference

本頁說明 gitresume.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 — 工作經歷

欄位	型別	必填	說明
`type`	`"experience"`	是
`title`	string	否	覆寫標題（預設 "Experience"）
`items`	array	是	經歷列表

每個 items 項目：

欄位	型別	必填	說明
`position`	string	是	職位名稱
`organization`	string	否	公司、社群或專案名稱
`location`	string	否	工作地點
`startDate`	date	是	到職日期
`endDate`	date \| null	否	離職日期（省略代表在職中）
`description`	string	否	工作內容與成就（支援 Markdown）

type: education — 學歷

欄位	型別	必填	說明
`type`	`"education"`	是
`title`	string	否	覆寫標題（預設 "Education"）
`items`	array	是	學歷列表

每個 items 項目：

欄位	型別	必填	說明
`institution`	string	是	學校名稱
`degree`	string	是	學位與主修
`location`	string	否	學校所在地
`startDate`	date	否	入學日期
`endDate`	date \| null	否	畢業日期
`description`	string	否	相關課程、榮譽等

type: skills — 技能

欄位	型別	必填	說明
`type`	`"skills"`	是
`title`	string	否	覆寫標題（預設 "Skills"）
`items`	array	是	技能分組列表

每個 items 項目：

欄位	型別	必填	說明
`category`	string	是	技能分類名稱（如「程式語言」、「框架」）
`items`	string[]	是	技能列表

type: generic — 通用結構化區塊

適合專案、證照、獎項等結構化內容。

欄位	型別	必填	說明
`type`	`"generic"`	是
`title`	string	是	區塊標題
`items`	array	是	項目列表

每個 items 項目：

欄位	型別	必填	說明
`title`	string	是	項目標題
`subtitle`	string	否	副標題或發行單位
`url`	string	否	連結
`startDate`	date	否	開始日期
`endDate`	date \| null	否	結束日期
`description`	string	否	補充說明（支援 Markdown）

type: list — 純列表

適合著作、語言能力、社群角色等簡單列表。

欄位	型別	必填	說明
`type`	`"list"`	是
`title`	string	是	區塊標題
`items`	string[]	是	項目列表（每項支援 Markdown）

日期格式

所有日期欄位支援三種格式：

YYYY — 僅年份（如 "2024"）
YYYY-MM — 年月（如 "2024-03"）
YYYY-MM-DD — 完整日期（如 "2024-03-15"）

重要：在 YAML 中，日期務必加上引號，避免被當成數字。例如寫 "2024-03" 而不是 2024-03。

Markdown 支援

以下欄位支援 Markdown 語法：

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

支援的語法：**粗體**、*斜體*、`行內程式碼`、[連結](URL)、- 列表

YAML 撰寫提示

使用 |（literal block）撰寫多行文字，保留換行符號
使用 >-（folded block）將多行文字合併為一行，適合長段落
包含冒號 : 或特殊字元的文字需使用引號括起來
使用 # 加上註解

完整範例

參考我們的 resume-template 取得完整的 gitresume.yaml 範例檔案。