Skip to content

Commit 08cee68

Browse files
CopilotKSemenenko
andcommitted
Update README with new supported formats and documentation
Co-authored-by: KSemenenko <4385716+KSemenenko@users.noreply.github.com>
1 parent ac94fe7 commit 08cee68

1 file changed

Lines changed: 31 additions & 5 deletions

File tree

README.md

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ A modern C# .NET library for converting various document formats (HTML, PDF, DOC
2121
|--------|-----------|---------|-------------|
2222
| **HTML** | `.html`, `.htm` | ✅ Supported | Full HTML to Markdown conversion |
2323
| **Plain Text** | `.txt`, `.md`, `.json` | ✅ Supported | Direct text processing |
24-
| **PDF** | `.pdf` | 🚧 Planned | Adobe PDF documents |
25-
| **Word** | `.docx` | 🚧 Planned | Microsoft Word documents |
26-
| **Excel** | `.xlsx` | 🚧 Planned | Microsoft Excel spreadsheets |
27-
| **PowerPoint** | `.pptx` | 🚧 Planned | Microsoft PowerPoint presentations |
28-
| **Images** | `.jpg`, `.png`, `.gif` | 🚧 Planned | OCR-based text extraction |
24+
| **PDF** | `.pdf` | ✅ Supported | Adobe PDF documents with text extraction |
25+
| **Word** | `.docx` | ✅ Supported | Microsoft Word documents with formatting |
26+
| **Excel** | `.xlsx` | ✅ Supported | Microsoft Excel spreadsheets as tables |
27+
| **PowerPoint** | `.pptx` | ✅ Supported | Microsoft PowerPoint presentations |
28+
| **Images** | `.jpg`, `.png`, `.gif`, `.bmp`, `.tiff`, `.webp` | ✅ Supported | OCR-based text extraction |
2929

3030
### HTML Conversion Features
3131
- Headers (H1-H6) → Markdown headers
@@ -38,6 +38,23 @@ A modern C# .NET library for converting various document formats (HTML, PDF, DOC
3838
- Code blocks and inline code
3939
- Blockquotes
4040

41+
### PDF Conversion Features
42+
- Text extraction with page separation
43+
- Header detection based on formatting
44+
- List item recognition
45+
- Title extraction from document content
46+
47+
### Office Documents (DOCX/XLSX/PPTX)
48+
- **Word (.docx)**: Headers, paragraphs, tables, bold/italic formatting
49+
- **Excel (.xlsx)**: Spreadsheet data as Markdown tables with sheet organization
50+
- **PowerPoint (.pptx)**: Slide-by-slide content with title recognition
51+
52+
### Image OCR Features
53+
- Support for multiple formats: JPEG, PNG, GIF, BMP, TIFF, WebP
54+
- Text extraction using Tesseract OCR
55+
- Header detection and paragraph formatting
56+
- Graceful fallback when OCR fails
57+
4158
## 🚀 Quick Start
4259

4360
### Installation
@@ -59,6 +76,15 @@ dotnet add package MarkItDown
5976
- .NET 8.0 SDK or later
6077
- Compatible with .NET 8.0+ projects (ready for .NET 9)
6178

79+
### Optional Dependencies for Advanced Features
80+
- **PDF Support**: Included via iText7 (automatically installed)
81+
- **Office Documents**: Included via DocumentFormat.OpenXml (automatically installed)
82+
- **Image OCR**: Requires Tesseract OCR data files
83+
- Install Tesseract: `apt-get install tesseract-ocr` (Linux) or `brew install tesseract` (macOS)
84+
- Set `TESSDATA_PREFIX` environment variable to Tesseract data directory if needed
85+
86+
> **Note**: All dependencies except Tesseract OCR data are automatically managed via NuGet packages.
87+
6288
## 💻 Usage
6389

6490
### Basic API Usage

0 commit comments

Comments
 (0)