Getting Started

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

1. Sign Up

2. Choose Your Username

A username is automatically derived from your login. If it's unavailable, you'll be asked to choose one during onboarding. This becomes part of your public resume URL: gitresume.co/@username/slug. Usernames cannot be changed once set.

3. Grant Repository Access

GitResume needs access to your GitHub repositories to read your resume file and trigger automatic builds. You'll be redirected to GitHub to authorize access (via GitHub App). You can grant access to just the repository containing your resume — no need to open up everything.

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

4. Create a Project

Click "Create Project" in the dashboard. You can:

Select an existing repo — pick from your authorized repositories
Create a new repo from template — use our resume-template to get started quickly with a sample resume.yaml

Then fill in:

Project name — the name shown in your dashboard
Slug — your public URL, e.g. gitresume.co/@username/slug
Branch — the Git branch to watch (default: main)
Resume path — path to the YAML file in the repo (default: resume.yaml)

5. 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.

6. Build

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

7. View Your Resume

Once built, you can:

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