快速上手

GitResume 讓你用 YAML 撰寫履歷，推送到 GitHub 後自動產生精美的 PDF 和網頁。以下是從零開始的完整流程。

1. 登入

前往 gitresume.co，使用 GitHub 或 Google 帳號一鍵登入。不需要另外註冊帳號。

2. 選擇使用者名稱

系統會自動從你的登入帳號推導使用者名稱。若該名稱已被使用，系統會在初次設定時請你手動選擇。這將成為你公開履歷網址的一部分：gitresume.co/@username/slug。使用者名稱設定後無法變更。

3. 授權儲存庫存取

GitResume 需要存取你的 GitHub 儲存庫來讀取履歷檔案並觸發自動建置。系統會引導你到 GitHub 進行授權（透過 GitHub App 機制），你可以只授權包含履歷的儲存庫，不需要開放所有儲存庫。

你隨時可以到 GitHub 設定中調整 GitResume 可存取的儲存庫範圍。

4. 建立專案

在 Dashboard 中點擊「建立專案」，你可以：

  • 選擇現有 repo — 從已授權的 repo 列表中選擇
  • 從模板建立新 repo — 使用我們的 resume-template 快速建立，裡面已經有範例 resume.yaml

接著填寫：

  • 專案名稱 — 顯示在 Dashboard 上的名稱
  • Slug — 你的公開 URL，例如 gitresume.co/@username/slug
  • 分支 — 要追蹤的 Git 分支（預設 main）
  • Resume 路徑 — YAML 檔案在 repo 中的路徑（預設 resume.yaml）

5. 撰寫 YAML

用你喜歡的任何編輯器（VS Code、Vim、甚至 AI 工具）編輯 resume.yaml。完整的欄位說明請參考 YAML Schema Reference。

最基本的 YAML 結構如下：

personalInfo:
  name: 王小明
  title: 軟體工程師
  email: [email protected]
  location: 台北, 台灣

sections:
  - type: summary
    content: >-
      三年經驗的全端工程師，熟悉 React 與 Go。

  - type: experience
    items:
      - position: 軟體工程師
        organization: Example Corp
        startDate: "2022-01"
        description: |
          - 開發並維護公司核心產品
          - 使用 **React** 與 **Go** 建構微服務架構

  - type: skills
    items:
      - category: 程式語言
        items: [TypeScript, Go, Python]

6. 建置

有兩種觸發建置的方式：

  1. 自動建置 — 每次 git push 到指定分支，GitResume 都會透過 Webhook 自動觸發建置
  2. 手動建置 — 在專案頁面點擊「立即建置」按鈕

建置完成後，系統會同時產生 PDF 和 HTML 兩種格式。

7. 查看成果

建置成功後，你可以在 Dashboard 中：

  • 下載 PDF — 取得可直接投遞的履歷檔案
  • 預覽 HTML — 查看網頁版履歷
  • 發布 — 將履歷發布到 gitresume.co/@username/slug，取得可分享的公開連結

下一步