https://github.com/haath/yaml-cv
Static CV generator from a YAML file, in HTML or PDF format.
https://github.com/haath/yaml-cv
cv gem generator html pdf resume ruby
Last synced: 12 months ago
JSON representation
Static CV generator from a YAML file, in HTML or PDF format.
- Host: GitHub
- URL: https://github.com/haath/yaml-cv
- Owner: haath
- License: mit
- Created: 2019-02-19T12:40:04.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2021-04-20T08:28:12.000Z (about 5 years ago)
- Last Synced: 2025-05-03T10:03:31.562Z (12 months ago)
- Topics: cv, gem, generator, html, pdf, resume, ruby
- Language: Ruby
- Homepage: https://gmantaos.github.io/yaml-cv/
- Size: 217 KB
- Stars: 12
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
yaml-cv
[ ](https://travis-ci.com/gmantaos/yaml-cv)
[](https://rubygems.org/gems/yaml-cv)
[](https://rubygems.org/gems/yaml-cv)
[](LICENSE)
=====================
Static CV generator from a YAML file, in HTML or PDF format.
[Demo](https://gmantaos.github.io/yaml-cv/)
## Installation
```shell
$ 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.
```yml
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](examples).
By default, the output will be printed to stdout in HTML format.
```shell
$ yaml-cv my_cv.yml
Doe John - Public Figure
...
```
To save to a file, use one or both of the `--html` and `--pdf` arguments, while specifying the output file to write to.
```shell
$ yaml-cv my_cv.yml --html my_cv.html
```
```shell
$ yaml-cv my_cv.yml --pdf my_cv.pdf
```
For PDF generation on Windows, [wkhtmltopdf.exe](https://wkhtmltopdf.org/downloads.html) 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.
```shell
$ yaml-cv my_cv.yml --html my_cv.html --watch
```