undoc 0.2.0

High-performance Microsoft Office document extraction to Markdown
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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148

# Undoc

High-performance Microsoft Office document extraction to Markdown for .NET.

## Installation

```bash
dotnet add package Undoc
```

## Usage

### Basic Usage

```csharp
using Undoc;

// Parse a document
using var doc = UndocDocument.ParseFile("document.docx");

// Convert to Markdown
var markdown = doc.ToMarkdown();
Console.WriteLine(markdown);

// Convert to plain text
var text = doc.ToText();

// Convert to JSON
var json = doc.ToJson();
```

### With Markdown Options

```csharp
using Undoc;

using var doc = UndocDocument.ParseFile("document.xlsx");

var options = new MarkdownOptions
{
    IncludeFrontmatter = true,
    ParagraphSpacing = true
};

var markdown = doc.ToMarkdown(options);
```

### Parse from Bytes

```csharp
using Undoc;

byte[] data = File.ReadAllBytes("document.pptx");

using var doc = UndocDocument.ParseBytes(data);
var markdown = doc.ToMarkdown();
```

### Extract Resources (Images)

```csharp
using Undoc;

using var doc = UndocDocument.ParseFile("document.docx");

// Get all resource IDs
var resourceIds = doc.GetResourceIds();

foreach (var id in resourceIds)
{
    // Get resource metadata
    using var info = doc.GetResourceInfo(id);
    var filename = info?.RootElement.GetProperty("filename").GetString();
    Console.WriteLine($"Resource: {filename}");

    // Get resource binary data
    var data = doc.GetResourceData(id);
    if (data != null && filename != null)
    {
        File.WriteAllBytes(filename, data);
    }
}
```

### Document Metadata

```csharp
using Undoc;

using var doc = UndocDocument.ParseFile("document.docx");

Console.WriteLine($"Title: {doc.Title}");
Console.WriteLine($"Author: {doc.Author}");
Console.WriteLine($"Sections: {doc.SectionCount}");
Console.WriteLine($"Resources: {doc.ResourceCount}");
Console.WriteLine($"Library Version: {UndocDocument.Version}");
```

## Supported Formats

- **DOCX** - Microsoft Word documents
- **XLSX** - Microsoft Excel spreadsheets
- **PPTX** - Microsoft PowerPoint presentations

## Features

- **RAG-Ready Output**: Structured Markdown optimized for RAG/LLM applications
- **High Performance**: Native Rust implementation via P/Invoke
- **Asset Extraction**: Images and embedded resources
- **Metadata Preservation**: Document properties, styles, formatting
- **Cross-Platform**: Windows, Linux, macOS (Intel & ARM)

## API Reference

### UndocDocument Class

#### Static Methods

- `ParseFile(string path)` - Parse document from file path
- `ParseBytes(byte[] data)` - Parse document from bytes

#### Instance Methods

- `ToMarkdown(MarkdownOptions? options)` - Convert to Markdown
- `ToText()` - Convert to plain text
- `ToJson(bool compact)` - Convert to JSON
- `PlainText()` - Get plain text (fast extraction)
- `GetResourceIds()` - List of resource IDs
- `GetResourceInfo(string id)` - Resource metadata as JsonDocument
- `GetResourceData(string id)` - Resource binary data

#### Properties

- `Title` - Document title
- `Author` - Document author
- `SectionCount` - Number of sections
- `ResourceCount` - Number of resources
- `Version` (static) - Library version

### MarkdownOptions Class

- `IncludeFrontmatter` - Include YAML frontmatter
- `EscapeSpecialChars` - Escape special characters
- `ParagraphSpacing` - Add extra paragraph spacing

## License

MIT License - see [LICENSE](../../LICENSE) for details.