Getting Started

GitResume lets you write your resume in YAML, push it to GitHub, and automatically build a professional PDF and web page. Two ways to get started:

Use the Resume Builder — create your resume visually, then set up a GitHub repo
Write YAML directly — if you already have a repo with a resume.yaml

Option A: Start with the Resume Builder

1. Build Your Resume

Open the Resume Builder and fill in your information — no account needed.

2. Create a Repository

Click "Continue Setup" at the bottom of the builder. You'll be guided to create a new GitHub repository from our template, which includes a sample resume.yaml.

3. Sign In & Grant Access

Sign in with your GitHub or Google account, then grant GitResume access to your new repository. You only need to authorize the repositories containing your resume files.

4. Create Your Project

Select your repository from the list, give it a project name and slug. The slug becomes part of your public URL: gitresume.co/@username/slug. You'll be taken to your project page, where you can push your resume YAML to GitHub with one click.

Option B: Already Have a Repository

1. Sign Up

2. Grant Repository Access

Grant GitResume access to your GitHub repositories via GitHub App. You can grant access to just the repository containing your resume.

You can adjust which repositories GitResume can access anytime from your GitHub settings.

3. Create a Project

Select your repository, give it a project name and slug. The slug becomes part of your public URL: gitresume.co/@username/slug.

Write Your YAML

Edit resume.yaml using any editor you like — VS Code, Vim, or even AI tools. See the YAML Schema Reference for all available fields.

Build & Publish

Every git push triggers an automatic build via webhook. You can also click "Build Now" on the project page for a manual build. Once built:

Download the PDF from your dashboard
Preview the HTML version
Publish to gitresume.co/@username/slug and share it anywhere