resumed

Lightweight JSON Resume builder, no-frills alternative to resume-cli

Usage no npm install needed!

<script type="module">
  import resumed from 'https://cdn.skypack.dev/resumed';
</script>

README

Resumed

npm package version Build status Code coverage

👔 Lightweight JSON Resume builder, no-frills alternative to resume-cli.

  • 🗜️ Small (~125 lines)
  • 🧩 CLI and Node.js API
  • 🤖 TypeScript typings
  • 🎨 Theme auto-load
  • ⏱️ Async render support
  • 🧪 100% code coverage

Main differences from resume-cli

Resumed automatically loads and uses the first installed JSON Resume theme found when rendering (exporting) a resume, similar to how Prettier plugins work. If no theme is installed, Resumed will guide you on how to proceed. It will also let you know if multiple themes are found, which one it picked, and how to use another one.

In contrast, resume-cli comes with a theme, and requires specifying what theme to use if the default does not suit you. This is fine for most users, but it ties the default theme package release cycle to that of the CLI, and is a little more verbose.

While both tools can be used from the command line, Resumed also provides a fully-tested, strongly-typed Node.js API to create, validate and render resumes programatically.

To keep the implementation simple and dependencies to a minimum, Resumed makes some compromises in terms of features, such as no PDF export, local previews or YAML format support. If you miss any of these, you can combine Resumed with other tools, (e.g. Puppeteer for PDF generation) or use the official CLI tool.

Installation

npm install resumed jsonresume-theme-even # or your theme of choice

ℹ️ Global installation is not supported, as it breaks theme discovery.

Usage

$ resumed --help

  Usage
    $ resumed <command> [options]

  Available Commands
    render      Render resume
    init        Create sample resume
    validate    Validate resume

  For more info, run any command with the `--help` flag
    $ resumed render --help
    $ resumed init --help

  Options
    -v, --version    Displays current version
    -h, --help       Displays this message

View real-world example.

Commands

render (default)

Render resume.

Usage: resumed render [filename] [options]

Aliases: export

Options:

  • -o, --output: Output filename (default resume.html)
  • -t, --theme: Theme to use, if more than one is installed
  • -h, --help: Display help message

init

Create sample resume.

Usage: resumed init [filename] [options]

Aliases: create

Options:

  • -h, --help: Display help message

validate

Validate resume.

Usage: resumed validate [filename] [options]

Options:

  • -h, --help: Display help message