unpdf 0.4.5

High-performance PDF content extraction to Markdown, text, and JSON
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

# Unpdf

.NET bindings for [unpdf](https://github.com/iyulab/unpdf) - High-performance PDF content extraction to Markdown, text, and JSON.

## Installation

```bash
dotnet add package Unpdf
```

## Quick Start

```csharp
using Unpdf;

// Convert PDF to Markdown
string markdown = Pdf.ToMarkdown("document.pdf");
Console.WriteLine(markdown);

// Convert PDF to plain text
string text = Pdf.ToText("document.pdf");
Console.WriteLine(text);

// Convert PDF to JSON
string json = Pdf.ToJson("document.pdf", pretty: true);
Console.WriteLine(json);

// Get document information
var info = Pdf.GetInfo("document.pdf");
Console.WriteLine($"Title: {info.Title}");
Console.WriteLine($"Pages: {info.PageCount}");

// Get page count
int pages = Pdf.GetPageCount("document.pdf");
Console.WriteLine($"Total pages: {pages}");

// Check if file is a valid PDF
bool isValid = Pdf.IsPdf("document.pdf");
Console.WriteLine($"Is valid PDF: {isValid}");
```

## Advanced Usage

### Convert with Options

```csharp
using Unpdf;

// Convert with frontmatter and image extraction
var options = new PdfOptions
{
    IncludeFrontmatter = true,
    ExtractImages = true,
    ImageOutputDir = "./images",
    Lenient = true
};

string markdown = Pdf.ToMarkdown("document.pdf", options);
Console.WriteLine(markdown);
```

### Extract Images

```csharp
using Unpdf;

// Extract all images from PDF
var images = Pdf.ExtractImages("document.pdf", "./output/images");

foreach (var image in images)
{
    Console.WriteLine($"Image: {image.Filename}");
    Console.WriteLine($"  Path: {image.Path}");
    Console.WriteLine($"  Type: {image.MimeType}");
    Console.WriteLine($"  Size: {image.Width}x{image.Height}");
    Console.WriteLine($"  Bytes: {image.SizeBytes}");
}
```

## API Reference

### `Pdf.ToMarkdown(string path)`
Convert a PDF file to Markdown format.

### `Pdf.ToMarkdown(string path, PdfOptions options)`
Convert a PDF file to Markdown format with options.

### `Pdf.ToText(string path)`
Convert a PDF file to plain text.

### `Pdf.ToJson(string path, bool pretty = false)`
Convert a PDF file to JSON format.

### `Pdf.GetInfo(string path)`
Get document metadata (title, author, page count, etc.)

### `Pdf.GetPageCount(string path)`
Get the number of pages in a PDF file.

### `Pdf.IsPdf(string path)`
Check if a file is a valid PDF.

### `Pdf.ExtractImages(string path, string outputDir)`
Extract all images from a PDF file to the specified directory.

### `Pdf.Version`
Get the version of the native library.

## PdfOptions

| Property | Type | Default | Description |
|----------|------|---------|-------------|
| `ExtractImages` | `bool` | `false` | Enable image extraction during conversion |
| `ImageOutputDir` | `string?` | `null` | Directory to save extracted images |
| `IncludeFrontmatter` | `bool` | `false` | Include YAML frontmatter with metadata |
| `Lenient` | `bool` | `true` | Continue parsing despite minor errors |

## License

MIT License