Skip to main content

Convert Markdown resumes to HTML and PDF

Project description

resume.md

Resume

Write your resume in Markdown, style it with CSS, output to resume.html and resume.pdf.

Prerequisites

  • Python ≥ 3.9 or uv
  • Optional, required for PDF output: Google Chrome or Chromium

Installation

Note: This package is not yet published to PyPI. Install from GitHub using one of the methods below.

Using uvx (recommended, no installation needed)

Run directly without installing:

uvx --from git+https://github.com/mikepqr/resume-markdown resume-markdown

Using uv tool install (persistent installation)

Install once, use everywhere:

uv tool install git+https://github.com/mikepqr/resume-markdown
resume-markdown

Using pip

pip install git+https://github.com/mikepqr/resume-markdown
resume-markdown

Usage

Quick start

  1. Create template files in your current directory:

    resume-markdown init
    # or with uvx: uvx --from git+https://github.com/mikepqr/resume-markdown resume-markdown init
    

    This creates resume.md and resume.css in the current directory.

  2. Edit your copy of resume.md with your resume content (the placeholder text is taken with thanks from the JSON Resume Project)

  3. Build HTML and PDF output:

    resume-markdown build
    # or with uvx: uvx --from git+https://github.com/mikepqr/resume-markdown resume-markdown build
    

Build options

  • Use --no-html or --no-pdf to disable HTML or PDF output:

    resume-markdown build --no-pdf
    
  • Use --chrome-path=/path/to/chrome if the tool cannot find your Chrome or Chromium executable (needed for PDF output)

    resume-markdown build --chrome-path=/path/to/chrome
    
  • Specify a custom input file:

    resume-markdown build myresume.md
    

Customization

Edit resume.css to change the appearance of your resume. 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

resume_markdown-0.9.0.tar.gz (141.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

resume_markdown-0.9.0-py3-none-any.whl (8.9 kB view details)

Uploaded Python 3

File details

Details for the file resume_markdown-0.9.0.tar.gz.

File metadata

  • Download URL: resume_markdown-0.9.0.tar.gz
  • Upload date:
  • Size: 141.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for resume_markdown-0.9.0.tar.gz
Algorithm Hash digest
SHA256 41e6bea9dbafac4218f81a2ad1876b9d5badf0f7483a10686f51758e1052962f
MD5 5c72013539dcfec8c8b5ee8b78ff99dd
BLAKE2b-256 c087c7584d65ae7c48205d9356005c8e0e9d401ef88b21d0b81d43228702c262

See more details on using hashes here.

Provenance

The following attestation bundles were made for resume_markdown-0.9.0.tar.gz:

Publisher: release.yml on mikepqr/resume-markdown

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file resume_markdown-0.9.0-py3-none-any.whl.

File metadata

File hashes

Hashes for resume_markdown-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e73ba8049edf7c39688dc403631c781d7b7e07141edafacdf22d93982a2010ab
MD5 bbfb457faf49d3465568e20b56d9a212
BLAKE2b-256 02c04072eab4a4a0d88db6c3bd33b8b253ed0ed55cdaa500a1cdd796bd498b95

See more details on using hashes here.

Provenance

The following attestation bundles were made for resume_markdown-0.9.0-py3-none-any.whl:

Publisher: release.yml on mikepqr/resume-markdown

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page