Skip to content
A modern static resume template and theme. Powered by Jekyll and GitHub pages.
HTML CSS Ruby Shell
Branch: master
Clone or download
Travis
Latest commit 1193df4 May 24, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE Update issue templates Jun 9, 2018
_data Added more layout options May 22, 2019
_includes Added more layout options May 22, 2019
_layouts Make more an optional section Dec 2, 2018
_sass Added more layout options May 22, 2019
_test Added more layout options May 22, 2019
assets Added more layout options May 22, 2019
lib/modern-resume-theme Bump modern-resume-theme to 1.6.1 [skip ci] May 23, 2019
scripts Updated bump-version script May 23, 2019
.dockerignore Added docker-compose Feb 9, 2019
.gitignore
.travis.yml Renamed project to modern-resume-theme Jun 20, 2018
CODE_OF_CONDUCT.md Added installation and usage doc parts Jun 16, 2018
CONTRIBUTING.md Renamed project to modern-resume-theme Jun 20, 2018
Gemfile Updates for examples Jun 8, 2018
Gemfile.lock Bump modern-resume-theme to 1.6.1 [skip ci] May 23, 2019
LICENSE Updated liscence Jun 16, 2018
Procfile Added Procfile Feb 9, 2019
README.md Added more layout options May 22, 2019
_config.yml Merge branch 'master' into develop Mar 21, 2019
app.json Add Heroku generated app.json Feb 9, 2019
docker-compose.yml Added docker-compose Feb 9, 2019
index.md Fixed spaces and added button.scss Jun 16, 2018
modern-resume-theme.gemspec Updated dependendies May 23, 2019
screenshot.png Updated readme screenshot Nov 21, 2018

README.md

modern-resume-theme Gem Version Build Status

A modern simple static resume template and theme. Powered by Jekyll and GitHub pages. Host your own resume on GitHub for free!

View Demo

img

Thank you for checking out my resume theme / template. If you have any feedback or suggestions for things I can add please let me know by either by raising an issue or feel free to send me an email to sprog31@gmail.com, I'm always happy to help.

I always enjoy seeing how people are using my creations and if you would like to say thanks feel free to buy me a coffee (buymeacoffee.com/vJ6HfLu).

If you would like to see how I am using this then you can view my resume here (jameswgrant.co.uk) and find the code here (sproogen/jameswgrant), hopefully this might help you.

You can view the project roadmap here.

Installation & setup guide

This template is designed to be hosted using GitHub pages and so that's what these instructions will cover. If you plan on hosting it seperately then there might be some extra steps that we wont cover.

Before starting it might be useful to familiarise yourself with Jekyll, Markdown and GitHub pages.

Step 1 - GitHub

Start by creating an account on GitHub

Step 2 - Create Repository

Create a repository on GitHub to hold your files and host your resume. You can find out how to do that here

Step 3 - Download Resume Template

Download and extract the following zip into the git repository you have just created. resume-template.zip

Step 4 - Push it

Commit and push the resume template to github

$ git add --all
$ git commit -m "Initial resume setup"
$ git push -u origin master
Set 5 - See it

You should now be able to see the demo resume template using this theme at [your-username].github.io

Usage

So now you will be able to see the demo template at your github url. You can can edit the yml files and replace the demo content with your own. Hopefully it will be fairly simple to work out where all the content goes, but here is a quick overview.

_config.yml

This will contain all the of the main configuration for your resume such as your name, email, social media links and about me content. It will also allow you to change the titles of some of the content sections. A full example of the _config.yml can be found here

_data/education.yml

A list of all your education, each education will follow this format

- layout: left (options: left, right, top, top-right, top-middle)
  name: Institution name
  dates: Date Range (eg. 2016 - 2019)
  qualification: Qualifications (eg. BA Performing Arts)
  quote: >
    Short institution or course description (optional)
  description: | # this will include new lines to allow paragraphs
    Description of qualification
_data/experience.yml

A list of all your experience, each experience will follow this format

- layout: left (options: left, right, top, top-right, top-middle)
  company: Company name
  link: Link to company (eg. https://google.com)(optional)
  job_title: Job title
  dates: Date Range (eg. November 2016 - present)
  quote: >
   Short description of the company (optional)
  description: | # this will include new lines to allow paragraphs
    Description of role

If you wish to specify multiple job titles for a single company, use this format

- layout: left (options: left, right, top, top-right, top-middle)
  company: Company name
  link: Link to company (optional)
  jobs:
    - title: Job title 1
      dates: Date Range (eg. November 2016 - present)
    - title: Job title 2
      dates: Date Range (eg. January 2015 - November 2016)
  quote: >
   Short description of the company (optional)
  description: | # this will include new lines to allow paragraphs
    Description of role
_data/projects.yml

A list of all your projects, each project will follow this format

- layout: left (options: left, right, top, top-right, top-middle)
  name: Project name
  link: Link to project (eg. https://sproogen.github.io/modern-resume-theme)(optional)
  github: Github page for project (eg. sproogen/modern-resume-theme)(optional)
  quote: >
    Short overview of the project (optional)
  description: | # this will include new lines to allow paragraphs
    Description about the work on/with the project
assets/main.scss

Add any css changes or additions you want to make here after the line @import 'modern-resume-theme';

Running locally

Before you start make sure you have Ruby and the gems for Jekyll installed locally. You can find out how to do that here.

  1. Clone your resume repository locally (if you haven't already)
  2. cd [your-repository-name]
  3. bundle install
  4. bundle exec jekyll serve
  5. Open your browser to http://localhost:4000

Any changes you make will automatically build and you will be able to see these by refreshing your browser.

Note: You will need to re-run bundle exec jekyll serve to see changes made in _config.yml.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/sproogen/modern-resume-theme. You can view our full guide to contributing here This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Development

Locally

Before you start make sure you have Ruby and the gems for Jekyll installed locally. You can find out how to do that here.

Note: You will need version 1.15.2 of bundler, as this is the only version that Heroku supports.

  1. Fork and or clone this repository locally
  2. cd modern-resume-theme
  3. bundle install
  4. bundle exec jekyll serve
  5. Open your browser to http://localhost:4000

Any changes you make will automatically build and you will be able to see these by refreshing your browser. To find out more about Jekyll take a look here.

Note: You will need to re-run bundle exec jekyll serve to see changes made in _config.yml.

Docker

If you have docker installed you can simply run docker-compose up to launch the site in a container, it will then be hosted at http://localhost:4000

License

The theme is available as open source under the terms of the MIT License.

You can’t perform that action at this time.