vektroi-d / cv-template

An easy way to create HTML and PDF versions of your resume, and automatically host them on GitHub Pages.

The Curriculum Vitae Template

You are an amazing developer. Keep your CV on GitHub. Host it on GitHub Pages. Have both HTML and PDF versions automatically generated and consistent. This is what good developers do.

What does this project do?

• Helps you to manage your CV as a web app (HTML + CSS + JS).
• Automatically generates and publishes HTML and PDF version on every push to master.

Demo: http://sneas.github.io/cv-template.

Real world example: http://sneas.github.io/cv.

Motivation

GitHub Pages is probably the best place developer could store it's CV. Giving a potential employer a link to your CV stored on GitHub shows your strong desire for automation and definitely stands you out.

The idea behind The Curriculum Vitae Template is to provide anyone a quick solution for creating and managing CV (both HTML and PDF versions) with the help of GitHub.

Installation

1. Create a new repo out of this template by clicking this link.
2. Clone the newly created repo.
3. Install project dependencies with npm install.
4. Run npm run deploy to initialize gh-pages. This is a one time action. Further deployments will be initiated by GitHub Actions on every push to master.

Usage

1. Start local development server with npm start.
2. Update contents of src folder to fit your needs. This item is explained below.
3. Commit and push your changes.
4. GitHub Actions will automatically build the latest version and deploy it to GitHub Pages.
5. Open http://your-username.github.io/your-cv-repo.

Update contents

The project uses HandlebarsJS as a template engine.

The main HTML template could be found in src/templates/index.html. Metadata for the template could be found in src/metadata/metadata.js.

Don't forget to update src/assets/favicon.ico. You can generate a new favicon out of your photo with icoconvert.com.