MarkPDFDown is designed to simplify the process of converting PDF documents into clean, editable Markdown text. By utilizing advanced multimodal AI models, it can accurately extract text, preserve formatting, and handle complex document structures including tables, formulas, and diagrams.

• PDF to Markdown Conversion: Transform any PDF document into well-formatted Markdown
• Image to Markdown Conversion: Transform image into well-formatted Markdown
• Multimodal Understanding: Leverages AI to comprehend document structure and content
• Format Preservation: Maintains headings, lists, tables, and other formatting elements
• Customizable Model: Configure the model to suit your needs

# Install uv if you haven't already
curl -LsSf https://astral.sh/uv/install.sh | sh

# Clone the repository
git clone https://github.com/MarkPDFdown/markpdfdown.git
cd markpdfdown

# Install dependencies and create virtual environment
uv sync

conda create -n markpdfdown python=3.9
conda activate markpdfdown

# Clone the repository
git clone https://github.com/MarkPDFdown/markpdfdown.git
cd markpdfdown

# Install dependencies
pip install -e .

# Set up your OpenAI API key
export OPENAI_API_KEY="your-api-key"
# Optionally, set up your OpenAI API base
export OPENAI_API_BASE="your-api-base"
# Optionally, set up your OpenAI API model
export OPENAI_DEFAULT_MODEL="your-model"

# pdf to markdown
python main.py < tests/input.pdf > output.md

# image to markdown
python main.py < input_image.png > output.md

python main.py page_start page_end < tests/input.pdf > output.md

docker run -i -e OPENAI_API_KEY=your-api-key -e OPENAI_API_BASE=your-api-base -e OPENAI_DEFAULT_MODEL=your-model jorbenzhu/markpdfdown < input.pdf > output.md

This project uses ruff for linting and formatting, and pre-commit for automated code quality checks.

# If using uv
uv sync --group dev

# If using pip
pip install -e ".[dev]"

# Install pre-commit hooks
pre-commit install

# Run pre-commit on all files (optional)
pre-commit run --all-files

# Format code with ruff
ruff format

# Run linting checks
ruff check

# Fix auto-fixable issues
ruff check --fix

• Python 3.9+
• uv (recommended for package management) or conda/pip
• Dependencies specified in pyproject.toml
• Access to the specified multimodal AI model

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

1. Fork the repository
2. Create your feature branch ( git checkout -b feature/amazing-feature )
3. Set up the development environment:

   uv sync --group dev
   pre-commit install

4. Make your changes and ensure code quality:

   ruff format
   ruff check --fix
   pre-commit run --all-files

5. Commit your changes ( git commit -m 'feat: Add some amazing feature' )
6. Push to the branch ( git push origin feature/amazing-feature )
7. Open a Pull Request

Please ensure your code follows the project's coding standards by running the linting and formatting tools before submitting.

This project is licensed under the Apache License 2.0. See the LICENSE file for details.

• Thanks to the developers of the multimodal AI models that power this tool
• Inspired by the need for better PDF to Markdown conversion tools