Getting Started

GitResume builds your YAML resume into a PDF and a web page. Three ways to start:

  1. Build it in the visual builder: no YAML needed
  2. Upload a YAML: you already have a gitresume.yaml
  3. Connect a GitHub repository: recommended if you know Git

Before You Start

  • Sign in: sign in with your GitHub or Google account. A GitHub account is only needed if you connect a repository.
  • Name your resume: on the Create your resume page, set a project name and a slug. The slug becomes your public URL: gitresume.co/@username/slug.

Choose How to Start

The Add your resume step on the Create your resume page, listing three options: connect a GitHub repository, build it in the visual builder, and upload your resume YAML, with a link below to import a PDF or Word resume with your AI assistant

Build it in the visual builder

Enter your details, add sections, and click "Create Project" to start the build.

Upload a YAML

Drop in your gitresume.yaml or paste its content. It is checked against the schema before the project is created.

Connect a GitHub repository

  1. Pick a repository, or create one from our template.
  2. Grant access to that repository through the GitHub App. We recommend "Only select repositories", granting access to just the one that holds your resume. GitHub's authorization page with Only select repositories chosen and a repository picker, followed by the permissions GitResume receives: read access to code and metadata, read and write access to deployments, and read access to email addresses
  3. Select the repository and create the project.

Every change is recorded in Git, and each branch you push gets its own build, so you can preview before merging.

Update Your Resume

  • Not connected to GitHub: click "Edit" on the project page, change the resume in the form or as YAML, then click "Build".

    The Edit resume page for a project not connected to GitHub, with an Upload file button and Form and YAML tabs at the top right. The Form tab shows fields for name, job title, email, phone, location, and links, and the bottom bar has a change note input with Cancel and Build buttons The same Edit resume page on the YAML tab, where the editor shows the gitresume.yaml content with line numbers and syntax highlighting, from personalInfo down to sections

  • Connected to GitHub: edit gitresume.yaml and push. The build starts automatically.

See the YAML Schema Reference for every field.

Build & Publish

Once a build finishes:

  • Download the PDF from your dashboard
  • Preview the HTML version
  • Publish to gitresume.co/@username/slug and share it anywhere
The web version of a resume built by GitResume, in a single-column layout with the name, title, contact details, Summary, Experience, Skills, Education, and References

Next Steps

Updated