markitdown-pdf-separators 0.2.0

MarkItDown with PDF page separators - convert PDFs to Markdown with page boundary markers

MarkItDown with PDF Page Separators

[!IMPORTANT] MarkItDown with PDF Page Separators is a Python package and command-line utility for converting various files to Markdown, with the addition of PDF page separator functionality.

This is a fork of the original MarkItDown project by Microsoft, adding PDF page separator support.

🆕 New Feature

PDF Page Separators

Convert PDFs to Markdown with clear page boundaries using the add_page_separators parameter:

from markitdown import MarkItDown

md = MarkItDown(enable_plugins=False)

# With page separators (new feature!)
result = md.convert("document.pdf", add_page_separators=True)
# Output includes "---" between pages

# Without page separators (default behavior)
result = md.convert("document.pdf", add_page_separators=False)
# Output is continuous text

Installation

From PyPI:

pip install markitdown-pdf-separators[all]

From source:

git clone https://github.com/yourusername/markitdown-pdf-separators.git
cd markitdown-pdf-separators
pip install -e .

Usage

Command-Line

# Basic conversion
markitdown path-to-file.pdf > document.md

# With page separators (if supported by your version)
markitdown path-to-file.pdf --add-page-separators > document.md

Python API

from markitdown import MarkItDown

# Initialize
md = MarkItDown(enable_plugins=False)

# Convert various file types
result = md.convert("test.xlsx")
print(result.markdown)

# Convert PDF with page separators
result = md.convert("document.pdf", add_page_separators=True)
print(result.markdown)

Supported File Types

• PDF (with page separators) ✨
• Word documents (.docx)
• Excel spreadsheets (.xlsx, .xls)
• PowerPoint presentations (.pptx)
• HTML files
• Plain text files
• Images (with OCR)
• Audio files (with transcription)
• And many more...

PDF Page Separators Feature

What it does:

• Extracts text page by page from PDFs
• Adds --- (Markdown horizontal rule) between pages
• Maintains document structure and readability
• Works with multi-page documents

Performance:

• Optimized for efficiency with large PDFs
• Minimal overhead compared to standard conversion
• Memory-efficient processing

Example Output:

Page 1 content here...

---

Page 2 content here...

---

Page 3 content here...

Development

This project is based on the original MarkItDown by Microsoft, with added PDF page separator functionality.

Key Changes:

• Added PDF page separator support
• Optimized performance for large documents
• Backward-compatible API

License

MIT License - see LICENSE file for details.

Acknowledgments

• Original MarkItDown project by Microsoft
• Based on work by Adam Fourney and contributors

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.