@borgius/jsonresume-theme-engineering

This is the engineering theme for JSON Resume, based off of jsonresume-theme-business-professional-compact and aims to implement the best practices for engineering resumes described in https://www.reddit.com/r/EngineeringResumes/wiki/index/. It is intended for senior/staff level engineers.

Quick Start (CLI)

Render your JSON Resume to PDF or HTML directly via npx:

# Generate PDF (default)
npx @borgius/jsonresume-theme-engineering resume.json

# Explicitly generate PDF
npx @borgius/jsonresume-theme-engineering --pdf resume.json

# Generate HTML
npx @borgius/jsonresume-theme-engineering --html resume.json

# Specify output path
npx @borgius/jsonresume-theme-engineering --pdf --out ./output/resume.pdf resume.json
npx @borgius/jsonresume-theme-engineering --html --out ./output/resume.html resume.json

CLI Options

Usage: npx @borgius/jsonresume-theme-engineering [options] <resume.json>

Arguments:
  resume.json          Path to your JSON Resume file

Options:
  --pdf                Export as PDF (default)
  --html               Export as HTML
  --out <path>         Output file path (default: same directory as input,
                       with .pdf or .html extension)
  -h, --help           Show this help message

Development

Prerequisites

• node.js
• npm

If you're on Linux, you can simply run:

sudo apt-get install nodejs-legacy npm

Or if you're on OSX and got Homebrew installed:

brew install node

Install dependencies

npm install

Render Resume

If you do not provide a resume.json at the root directory level, use the sample resume and render it as HTML:

cp sample-resume.json resume.json
npm run html

You should now see this message:

You can find your rendered resume at resume.html. Nice work! 🚀

PDF Export

To export your resume in PDF format:

npm run pdf

Alternatively, you can also do a print page on the browser and save it as as PDF (by setting margins to none and removing header/footers.)

Release

To run tests, bump the patch version, and publish to npm:

npm run release

To bump a specific version level:

npm version minor && npm publish --access public

Contribute

Contributions to the implementation of new functions or bug fixes are very welcome!

License

Available under the MIT license.