resume-md 1.0.3

Generate HTML resume from markdown

Markdown Resume Generator

A simple, lightweight tool to convert markdown-formatted resumes into beautiful, print-ready HTML documents styled with Tailwind CSS.

Features

• Convert Markdown to styled HTML resumes
• Modern design with Tailwind CSS
• Automatic header detection for contact information
• Print-optimized layout
• No external dependencies (Python standard library only)
• Responsive design for both screen and print

Installation

From PyPI

pip install resume-md

From Source

git clone [e-mail]:SamCullin/resume-md.git
cd resume-md
pip install -e .

Development Setup

To set up the development environment:

git clone [e-mail]:SamCullin/resume-md.git
cd resume-md
pip install -e ".[dev]"

Usage

Basic Usage

resume-md --input your_resume.md

This will generate an HTML file with the same name as your input file (e.g., your_resume.html).

Command Line Options

resume-md --help

Available options:

• --input, -i: Path to input markdown file (default: resume.md)
• --output, -o: Path to output HTML file (default: <input_name>.html)
• --template, -t: Path to HTML template file (use built-in template if not specified)
• --version, -v: Show version information and exit

Using as a Library

from resume_md.tokenizer import MarkdownTokenizer, read_markdown_file
from resume_md.component_factory import tokens_to_components
from resume_md.renderer import Renderer

# Read and tokenize markdown
markdown_text = read_markdown_file("resume.md")
tokenizer = MarkdownTokenizer(markdown_text)
tokens = tokenizer.tokenize()

# Convert tokens to components and render to HTML
components = tokens_to_components(tokens)
renderer = Renderer()
rendered = renderer.render_components(components)

# Access the header and content HTML
header_html = rendered["header"]
content_html = rendered["content"]

Markdown Format

The resume-md tool supports a specific markdown format designed for resumes. For examples, see:

• Example 1 - Basic resume format with tables
• Example 2 - Alternative resume format with lists

Development

Running Tests

pytest
# With coverage
pytest --cov=resume_md

Code Formatting

black resume_md
isort resume_md

Project Structure

• resume_md/: Main package
  • __init__.py: Package initialization
  • main.py: CLI entry point
  • tokenizer.py: Markdown tokenizer
  • components.py: Component data classes
  • component_factory.py: Converts tokens to components
  • renderer.py: Renders components as HTML
  • template.html: HTML template
• tests/: Test cases
• .github/workflows/: CI/CD workflows

Repository

• GitHub: https://github.com/SamCullin/resume-md
• SSH: [e-mail]:SamCullin/resume-md.git

License

MIT