Giter Site home page Giter Site logo

resumeman's Introduction

Resume Man

Resume Man is an HTML and PDF resume builder made in Ruby with Middleman.

It has the following features:

  • Separation between content and data, all your resume information is an YAML file.
  • Fork this project for maintening multiple versions of your resume in sync.
  • Markdown for formatting of the longer paragraphs.
  • Default template included: SRT.
  • You can preview your changes with Middleman's included server.
  • config.ru file included for use with Pow.
  • Automatic PDF generation using wkpdf (OS X) or wkhtmltopdf (other platforms).
  • Turnkey deployment to a http://yourusername.github.com/resume page no configuration necessary.
  • hResume microformat support

Preview

See the result: sample resume.

In practice

Fork this project and name it resume for example. Follow the installation instructions below.

To create/update your resume, you'll just need to edit the data/resume.yml file. All keys with a desc: | header can be Markdown formated.

Here is what it looks like:

info:
    name: Jonathan Doe
    shortdesc: Web Designer, Director
    email: [email protected]
    phone: (313) - 867-5309
    address:
        - 123 Fake Street
        - City, Country
    desc: |
        You can put Markdown in here [like this](http://daringfireball.net/projects/markdown/).

You can preview your changes via http://resume.dev/ if using Pow or http://localhost:4567/ otherwise.

bundle exec middleman build

Build the static version of your resume, it'll also create the PDF version.

bundle exec middleman deploy

Upload it to a github page. Your resume will be available at http://yourusername.github.com/resume.

Installation

Note: if you are on OS X and using rvm/rbenv, use the system Ruby. Wkpdf depends on Rubycocoa and works best with the system provided Ruby.

If you forked to your own repo:

git clone https://github.com/<yourusername>/resume.git
cd resume

Otherwise:

git clone https://github.com/reefab/ResumeMan.git
cd ResumeMan

Install all dependencies:

sudo gem install bundler
bundle install --path vendor/bundle

If using Pow, this will setup a previewing server that will be available at http://resume.dev/

ln -s `pwd`/. ~/.pow/resume

Otherwise, you'll have to launch the previewing server manually:

bundle exec middleman

Note on PDF generation

On OS X, wkpdf is used. It has a PDF output comparable to Safari and is perfectly adequate.

On the other hand, for other platforms Wkhtmltopdf doesn't have the best PDF rendering. Manually exporting a PDF version from Chrome might have a better result especially for page breaks.

resumeman's People

Contributors

reefab avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.