快速上手

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，获取一个可分享的公开链接

下一步