/yaml-cv

Static CV generator from a YAML file, in HTML or PDF format.

Primary LanguageHTMLMIT LicenseMIT

yaml-cv

Static CV generator from a YAML file, in HTML or PDF format.

Demo

Installation

$ gem install yaml-cv

Disclaimer: On versions 0.1 PDF generation will be a little rough, since I implemented the release system before getting around to that.

Usage

The CV can be drawn-out in a yaml file, similar to the one shown below.

details:
  first_name: John
  last_name: Doe

  title: Placeholder Engineer

profile: Personal description.

contact:
- text: johndoe@example.com
  url: mailto:johndoe@example.com
  icon: email

technical:
  - category: Languages
    items: C, C++, C#, HTML
  - category: Frameworks
    items: Node.js, React.js, Bootstrap

For more, there is the examples folder.

By default, the output will be printed to stdout in HTML format.

$ yaml-cv my_cv.yml
<html>
<head>
    <title> Doe John - Public Figure </title>

    <style>
...

To save to a file, use one or both of the --html and --pdf arguments, while specifying the output file to write to.

$ yaml-cv my_cv.yml --html my_cv.html
$ yaml-cv my_cv.yml --pdf my_cv.pdf

For PDF generation on Windows, wkhtmltopdf.exe needs to be in the PATH.

The --watch option can also be used to watch the input file for changes and automatically regenerate the output.

$ yaml-cv my_cv.yml --html my_cv.html --watch