Skip to content

gitresume-co/resume-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 

Repository files navigation

My Resume

Powered by GitResume — Resume as Code.

Live Preview: See what this template looks like when built by GitResume: gitresume.co/@gitresume-co/resume-template

Quick Start

  1. Click Use this template on GitHub to create your own repo
  2. Create your resume.yaml using the Resume Builder or by copying resume.example.yaml
  3. Connect your repo to GitResume
  4. Commit and push — GitResume automatically builds your PDF and web resume

Connect to GitResume

After creating your repo from this template, follow these steps to publish it with GitResume.

Step 1: Sign in

Go to gitresume.co/login and sign in with GitHub or Google.

If you sign in with Google but your resume repo is on GitHub, that's fine — you'll connect GitHub in the next step.

Step 2: Create a project

On the dashboard, click New Project (this takes you to the setup wizard).

2a — Grant repository access (first time only)

The wizard will prompt you to grant the GitResume GitHub App access to your repos. Pick:

  • Only select repositories (recommended) — choose just this resume repo
  • All repositories — convenient but broader than necessary

You can adjust this later from GitHub → Settings → Applications → GitResume, or directly at https://github.com/apps/gitresume-co/installations/select_target.

2b — Select your repo

Pick the repo you just created from the template. Use the search box if you have many repos.

2c — Fill in project details

  • Project name — defaults to the repo name; edit if you want
  • Slug — auto-generated from the name; the field shows a live URL preview. This becomes your public URL: gitresume.co/@<your-username>/<slug>. Lowercase letters, numbers, and hyphens only.

Click Create Project.

Using a filename other than resume.yaml (e.g. cv.yaml)? Create the project with the default first, then go to Project Settings → Resume Path and update it.

Step 3: Push your resume

Back in your local clone:

# If you haven't already, copy the example as a starting point
cp resume.example.yaml resume.yaml

# Edit resume.yaml, then:
git add resume.yaml
git commit -m "add my resume"
git push

GitResume's webhook receives the push and starts building automatically. Watch the build status on your project page; once green:

  • PDF — downloadable from the project dashboard
  • Web — published at gitresume.co/@<your-username>/<slug>

No webhook fired? Click Build Now on the project page to trigger one manually.

Tailoring for specific applications

Push to any non-default branch to build a tailored variant without touching your public resume:

git checkout -b company-acme
# edit resume.yaml to emphasise relevant experience
git commit -am "tailor for Acme"
git push -u origin company-acme

Branch builds appear in your project's build list alongside the main branch's builds, tagged with the branch name.

Editor Setup

For autocompletion and validation while editing resume.yaml, install the YAML extension (Red Hat) in VS Code. The schema comment at the top of the file enables it automatically. See resume.example.yaml for reference.

Resources

Releases

No releases published

Packages

 
 
 

Contributors