Project

md_resume

0.0
The project is in a healthy, maintained state
md_resumeelasticspoon/md_resumeHomepageDocumentationSource CodeBug Tracker
Write a resume in markdown, style it with CSS, edit it with a live server and distribute it as either HTML or PDF.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
684
Stars
2
Forks
0
Watchers
1
 Releases
Current version
0.1.3
Total releases
4
First release
2024-01-27
Latest release
2024-01-29
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2024-01-23
Reverse Dependencies
0

 Dependencies

Runtime

filewatcher
~> 2.1
kramdown
~> 2.4
webrick
~> 1.8
 Project Readme

md_resume

screencast_md_resume.mp4

Write your resume in Markdown, style it with CSS, output to HTML and PDF. Open a your resume in the browser and watch it update live with changes made to the markdown.

Prerequisites

  • Ruby ≥ 3.0
  • Optional, required for PDF output: Google Chrome or Chromium

Installation

gem install md_resume

Usage

Usage: md_resume command filename [options...]

Commands:
serve                   Start a local server to preview your resume
build                   Build your resume in html and pdf formats.
generate                Generate a template with given file name,
                        defaults to generating only a markdown template.

Specific options:
        --chrome-path=PATH           Path to Chrome executable
        --no-pdf                     Do [not] write pdf output
        --[no-]html                  Do [not] write html output
    -p, --pdf-path=PATH              Path of pdf output
    -h, --html-path=PATH             Path of html output
        --css-path=PATH              Path of css inputs.
        --server-port=PORT           Specify the localhost port number for the server
        --serve-only
        --no-open                    Do not automatically open browser when starting server
    -v, --[no-]verbose               Run verbosely
        --[no-]generate-md           Generate markdown template.
        --[no-]generate-css          Generate CSS template.

Common options:
        --help                       Show this message

Customization

You can generate the default style sheet with md_resume generate-css FILENAME. The default style is extremely generic, which is perhaps what you want in a resume, but CSS gives you a lot of flexibility. See, e.g. The Tech Resume Inside-Out for good advice about what a resume should look like (and what it should say).

Change the appearance of the PDF version (without affecting the HTML version) by adding rules under the @media print CSS selector. Change the margins and paper size of the PDF version by editing the @page CSS rule.

Note

The idea for the project is based off of https://github.com/mikepqr/resume.md. I could not get python to play nice so I rewrote it in Ruby and added features.

Development

No clue currently. I still have not written proper tests for this.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/elasticspoon/md_resume.

License

The gem is available as open source under the terms of the MIT License.