Skip to content

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 

Repository files navigation

📄 PDF2md - PDF to Markdown Converter 🔄

PDF2md - A powerful Python tool that converts PDF files to clean Markdown while perfectly preserving the original structure and layout. Perfect for invoices, letters, and formatted documents!

Perfect for:

  • Converting business documents
  • Extracting text from PDFs while keeping formatting
  • Creating Markdown versions of your PDF files

🚀 Installation

Standard Installation

pip install .

Installation from GitHub

pip install git+https://github.com/daMustermann/PDF2md.git

Using pipx (isolated environment)

pipx install git+https://github.com/daMustermann/PDF2md.git

Development Setup

git clone https://github.com/daMustermann/PDF2md.git
cd pdf2markdown
pip install -e .[dev]

Verify Installation

pdf2md --version

💻 Usage

Convert a PDF file to Markdown:

pdf2md input.pdf output.md

⚙️ Options

  • --debug: Enable debug output (shows processing details)

🌟 Features

  • ✅ Preserves document structure (headings, lists, tables)
  • ✅ Maintains original formatting (bold, italic text)
  • ✅ Handles complex documents (invoices, letters, reports)
  • ✅ Supports UTF-8 encoding (works with international characters)
  • ✅ Lightweight and fast processing

📋 Example

Convert a document:

pdf2md document.pdf document.md

🔧 Requirements

  • Python 3.6+
  • pdfplumber 0.10.0+

🤝 Contributing

Contributions are welcome! Please open an issue or submit a pull request.

📜 License

MIT

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages