Skip to content

docs: clarify OCR requires markitdown-ocr plugin #1608

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Jah-yee wants to merge 1 commit into
base: main
Choose a base branch
from
+9 −1
Open

docs: clarify OCR requires markitdown-ocr plugin #1608

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ MarkItDown currently supports the conversion from:
- PowerPoint
- Word
- Excel
- Images (EXIF metadata and OCR)
- Images (EXIF metadata and OCR — requires `markitdown-ocr` plugin)
- Audio (EXIF metadata and speech transcription)
- HTML
- Text-based formats (CSV, JSON, XML)
Expand Down Expand Up @@ -162,6 +162,14 @@ print(result.text_content)

If no `llm_client` is provided the plugin still loads, but OCR is silently skipped and the standard built-in converter is used instead.

**CLI Usage:**

```bash
pip install markitdown-ocr
export OPENAI_API_KEY="your-api-key"
markitdown --use-plugins document_with_images.pdf -o document.md
```

See [`packages/markitdown-ocr/README.md`](packages/markitdown-ocr/README.md) for detailed documentation.

### Azure Document Intelligence
Expand Down