Skip to content

Commit a6ad2ac

Browse files
committed
docs: clarify OCR requires markitdown-ocr plugin
- Update feature list to note OCR requires markitdown-ocr plugin - Add CLI usage example for OCR plugin - Addresses issue #1601: OCR is not working
1 parent c6308dc commit a6ad2ac

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ MarkItDown currently supports the conversion from:
2121
- PowerPoint
2222
- Word
2323
- Excel
24-
- Images (EXIF metadata and OCR)
24+
- Images (EXIF metadata and OCR — requires `markitdown-ocr` plugin)
2525
- Audio (EXIF metadata and speech transcription)
2626
- HTML
2727
- Text-based formats (CSV, JSON, XML)
@@ -162,6 +162,14 @@ print(result.text_content)
162162

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

165+
**CLI Usage:**
166+
167+
```bash
168+
pip install markitdown-ocr
169+
export OPENAI_API_KEY="your-api-key"
170+
markitdown --use-plugins document_with_images.pdf -o document.md
171+
```
172+
165173
See [`packages/markitdown-ocr/README.md`](packages/markitdown-ocr/README.md) for detailed documentation.
166174

167175
### Azure Document Intelligence

0 commit comments

Comments
 (0)