Package Exports

markdown-resume

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (markdown-resume) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

markdown-resume.js

Turn a simple markdown document into a resume in HTML and PDF.

This module borrows heavily from the PHP script markdown-resume.

Features

PDF generation via wkhtmltopdf
Responsive design for multiple device viewport sizes
Simple Markdown formatting

Quickstart

The generated files will be put in the same directory as your source file.

# For usage on the command line
npm install -g markdown-resume

# Generate HTML file
md2resume my-resume-file.md

# Generate PDF file
md2resume --pdf my-resume-file.md

Running with docker

# Build a docker image
docker build -t md2resume .

# In the directory where your resume is, run the container
docker run -v $PWD:/src md2resume resume.md

# You can also generate the pdf format
docker run -v $PWD:/src md2resume -pdf resume.md

Run in Watch Mode w/ Live Reload

npm install -g light-server
light-server -s . -w "your_resume.md # md2resume your_resume.md"

Open http://localhost:4000/your_resume.html in a browser and see changes live.

Use as a node module

var md2resume = require('markdown-resume')

# Generate HTML
md2resume.generate('my-resume-file.md', function(err, out) {
    # ... do something with 'out'
});

# Same as a above
md2resume.generate('my-resume-file.md', { format: 'html' }, function(err, out) { ... });

# Generate PDF
md2resume.generate('my-resume-file.md', { format: 'pdf' }, function(err, pdf) {
    # ... do something with pdf
});

Acknowledgments

As above, this library steals pretty much everything from markdown-resume.