LaTeX Resume Generator

A Ruby script that generates professional resumes in PDF format from YAML content using LaTeX templates. Features multiple styling configurations and live reload capabilities.

Features

• Generate ATS-friendly PDF resumes from YAML content
• Multiple style configurations (compact, loose, different font sizes)
• Live reload - automatically regenerates PDF when files change
• Markdown-style bold text support
• Customizable spacing and formatting
• Support for links and special LaTeX characters

Prerequisites

• MacOS (tested)
• Ruby
• MiKTeX (LaTeX distribution)
  • Download from: https://miktex.org/download
• Bundler (Ruby package manager)

Installation

1. Clone the repository

2. Install Ruby with RVM (suggested): https://rvm.io/rvm/install

\curl -sSL https://get.rvm.io | bash

source ~/.rvm/scripts/rvm

rvm install 3.1 --default

gem install bundler

3. Install Ruby and dependencies in the project directory:

bundle install

4. Install MiKTeX: Download and install from: https://miktex.org/download Suggest install as admin and select "Install missing packages on-the-fly"

Troubleshooting

if you encounter the following error when running the generate.rb or watcher.rb script:

ERROR pdflatex - /usr/local/bin/miktex did not succeed; exitCode: 1

You should check the MiKTeX Console:

1. make sure MiKTeX is on Admin mode.
2. update to standard Tex installation.

Then try to run generate.rb, it may prompt you to install some missing packages, just click install and it should work.

Usage

1. Content Configuration

Create or edit YAML files in the contents/ directory. See example structure:

title: Demo Person
info:
  - text: Vancouver, BC
  - text: [email protected]
    href: "mailto:[email protected]"
  - text: linkedin.com/in/demo-person
    href: https://www.linkedin.com/in/demo-person/
  - text: github.com/demo-person
    href: https://github.com/demo-person
  - text: demo.example.com
    href: https://demo.example.com
about: Example software developer showcasing resume template capabilities # Optional

2. Style Configuration

Edit or create YAML files in config/ directory to customize styling:

• default.yml - Base configuration
• compact.yml - Compressed spacing
• loose.yml - Relaxed spacing
• smallfont.yml - Smaller font size
• biggerfont.yml - Larger font size
• highlight.yml - Enable bold text highlighting

3. Generate Resume

One-time generation:

ruby generate.rb

Watch mode (auto-regenerate on changes):

ruby watcher.rb

The script will monitor:

• Content files (contents/*.yml)
• LaTeX template (template.tex.erb)
• Generator script (generate.rb)
• Configuration files (config/*.yml)

Output

Generated files will be placed in:

• output/<content_name>/tex/ - LaTeX source files
• output/<content_name>/pdf/ - Generated PDF files

Tips

• Use **text** in YAML content for bold text (when highlight configuration is enabled)
• Use Visual Studio Code's word wrap (Opt/Alt + Z) for easier YAML editing
• Multiple resume versions can be created by using different config files
• LaTeX template can be customized in template.tex.erb

File Structure

├── config/           # Style configurations
├── contents/         # Resume content in YAML
├── output/          # Generated files
│   └── <name>/
│       ├── tex/     # LaTeX source
│       └── pdf/     # PDF output
├── generate.rb      # Main generator script
├── watcher.rb       # File watcher for live reload
├── template.tex.erb # LaTeX template
└── README.md

License

The base format of the LaTeX template is derived from sb2nov/resume, used under the MIT License.

            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
                    Version 2, December 2004

 Copyright (C) 2024 Jin Xu <[email protected]>

 Everyone is permitted to copy and distribute verbatim or modified
 copies of this license document, and changing it is allowed as long
 as the name is changed.

            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

  0. You just DO WHAT THE FUCK YOU WANT TO.