https://github.com/mmorga/resume-builder
Tool to build resume in various formats from YAML source
https://github.com/mmorga/resume-builder
Last synced: 4 months ago
JSON representation
Tool to build resume in various formats from YAML source
- Host: GitHub
- URL: https://github.com/mmorga/resume-builder
- Owner: mmorga
- Created: 2025-02-26T19:40:48.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-03-11T20:16:56.000Z (over 1 year ago)
- Last Synced: 2025-03-11T21:24:37.852Z (over 1 year ago)
- Language: Ruby
- Size: 65.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README
Awesome Lists containing this project
README
# README
This project reads in a YAML formatted file containing a resume and produces resumes in HTML (self-contained, single file), PDF (via [Weasyprint](https://weasyprint.org/)), and PDF (via [Pandoc][https://pandoc.org/]).
## Getting started
Dependencies:
* [Ruby](https://www.ruby-lang.org/en/documentation/installation/) 3.1 or newer
* [Weasyprint](https://weasyprint.org/) for PDF generation
* [Pandoc][https://pandoc.org/] for Word DOCX generation
### Mac simple setup
Simple setup (on mac with [Homebrew](https://brew.sh/) installed):
Run `bin/setup`
### Other OS
Install the dependencies above, then execute in the root directory:
`bundle install`
## Building a resume
Once you have a resume created (example: `markmorga-resume.yaml`) in the project root directory, you can build it with the command:
`rake` (or if this gives you trouble) `bundle exec rake`
You can also use [Guard](https://github.com/guard/guard) to monitor changes to files and build as you save your YAML file (or any template files).
`guard` (or if this gives you trouble) `bundle exec guard`
## Project map
* `bin/setup` (Mac only) installs dependencies via Mac [Homebrew](https://brew.sh/) and bundler
* `build` Created during the build process
* `erb` Ruby ERB templates for the HTML generated by the build
* `src` Ruby source for the code generator
* `style` CSS for the generated HTML
## TODO
* Implement microformats:
* [h-resume on microformats.org](https://microformats.org/wiki/h-resume)
* Potential microformat profiles to include:
* ``
* ``
* ``
* ``
* ``
* ``
* ``
* Other profiles
* ``
* ``
* [ProfilePage on schema.org](http://schema.org/ProfilePage)
``
* [Open Graph Protocol](https://ogp.me/) ``
* ``
* ``
* ``
* ``
* ``
* ``
* ``
* ``
* ``
* Images for icons, etc.