mdqpdf

Markdown to PDF converter CLI tool written in Go.

Features

• Convert Markdown files to PDF format
• Support for GitHub Flavored Markdown (GFM)
  • Tables
  • Task lists
  • Strikethrough
• Image embedding (relative paths, absolute paths, URLs)
• A4 page size output
• Cross-platform (Linux, macOS, Windows)

Installation

From Source

go install github.com/youyo/mdqpdf/cmd/mdqpdf@latest

Build Locally

git clone https://github.com/youyo/mdqpdf.git
cd mdqpdf
go build -o mdqpdf ./cmd/mdqpdf

Usage

Basic Conversion

mdqpdf input.md
# Output: input.pdf

Custom Output Path

mdqpdf input.md output/document.pdf

Verbose Mode

mdqpdf --verbose input.md

Help and Version

mdqpdf --help
mdqpdf --version

Examples

Convert README to PDF

mdqpdf README.md

Convert with Custom Output

mdqpdf docs/guide.md output/guide.pdf

Development

Prerequisites

• Go 1.21 or later
• golangci-lint (for linting)

Build

go build -o mdqpdf ./cmd/mdqpdf

Run Tests

# All tests
go test ./...

# Contract tests only
go test ./tests/contract/...

# Integration tests only
go test ./tests/integration/...

Linting

golangci-lint run

Architecture

The project follows a library-first architecture:

• lib/converter/ - Core conversion logic
• lib/validator/ - Input validation
• lib/logger/ - Structured logging
• cmd/mdqpdf/ - CLI interface
• tests/ - Test suites

License

MIT License

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for details.