pptx-to-md

pptx-to-md is a library to parse Microsoft PowerPoint (.pptx) slides and convert them into structured Markdown content and data, making it easy to process, use, or integrate slide data programmatically. It also supports OpenDocument Presentation (.odp).

🚀 Features

• 🖥️ Compatibility: Supports .pptx and .odp files
• 📄 Extract Slide Text: Parses and extracts text elements from slides.
• 📋 Lists & Tables: Recognizes and formats lists (ordered/unordered) and tables into Markdown.
• 🖼️ Embedded Images: Supports embedded images extraction as base64-encoded inline images.
• 💾 Memory Efficient: Use the streaming API to iterate over one slide at a time, never overloading memory.
• ⏱️ Multithreading: Optional support for multithreaded parsing of PowerPoint slides, with a significant performance increase for larger presentations.
• ⚙️ Robust & Safe APIs: Designed according to Rust best practices with explicit error handling.
• 🏷️ Presentation Metadata: Extracts common document properties from PPTX and ODP.
• 🪄 Embedding: Used to provide pptx content and meta information in a form that is useful for embeddings

👨‍💻 Example Usage

PresentationContainer is the recommended entry point for new code. It detects whether the input is a PowerPoint (.pptx) or OpenDocument Presentation (.odp) file and exposes the same parsing API for both formats.

use pptx_to_md::{ImageHandlingMode, ParserConfig, PresentationContainer};
use std::path::Path;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let config = ParserConfig::builder()
        .include_presentation_metadata(true)
        .compress_images(true)
        .quality(80)
        .image_handling_mode(ImageHandlingMode::InMarkdown)
        .include_slide_number_as_comment(true)
        .include_speaker_notes(false)
        .include_comments(false)
        .build();

    let mut container = PresentationContainer::open(
        Path::new("path/to/presentation.pptx"), // or .odp
        config,
    )?;

    let markdown = container.convert_to_md()?;
    std::fs::write("output.md", markdown)?;
    
    Ok(())
}

PresentationContainer::convert_to_md() is the preferred API for converting a complete PPTX or ODP document. It emits presentation metadata once at the start and then appends all slide Markdown in order. The existing parse_all(), streaming, and per-slide APIs remain available for structured processing.

To access metadata as structured Rust values without converting slides, see examples/presentation_metadata.rs.

For PPTX-only code, PptxContainer remains available for backwards compatibility and for callers that explicitly want the old PowerPoint-only entry point. New code that may handle both formats should prefer PresentationContainer. For more usage examples, refer to the examples directory.

PPTX and ODP auto-detection

Use PresentationContainer when the input may be either .pptx or .odp:

use pptx_to_md::{ParserConfig, PresentationContainer, PresentationFormat};
use std::path::Path;

let mut presentation = PresentationContainer::open(
    Path::new("path/to/presentation.odp"),
    ParserConfig::default(),
)?;

assert_eq!(presentation.format(), PresentationFormat::Odp);
let slides = presentation.parse_all()?;
# Ok::<(), pptx_to_md::Error>(())

If the format is already known, use open_as to skip auto-detection:

use pptx_to_md::{ParserConfig, PresentationContainer, PresentationFormat};
use std::path::Path;

let mut presentation = PresentationContainer::open_as(
    Path::new("path/to/presentation.pptx"),
    ParserConfig::default(),
    PresentationFormat::Pptx,
)?;

let slides = presentation.parse_all()?;
# Ok::<(), pptx_to_md::Error>(())

Config Parameters

Member of ImageHandlingMode

🏗 Project Structure

pptx-to-md/
├── Cargo.toml
├── README.md
├── CHANGELOG.md
├── LICENSE-MIT
├── LICENSE-APACHE
├── examples/           # Simple examples to present the usage of this crate
│   ├── basic_usage.rs
│   ├── presentation_metadata.rs
│   ├── manual_image_extraction.rs
│   ├── memory_efficient_streaming.rs
│   ├── performance_test.rs
│   ├── save_images.rs
│   └── slide_elements.rs
├── src/
│   ├── lib.rs            # Public API
│   ├── container.rs      # Pptx container handling
│   ├── presentation.rs   # Format-detecting presentation container
│   ├── odp.rs            # ODP container handling
│   ├── parser_config.rs  # Config and config builder
│   ├── slide.rs          # Individual slide representation & markdown conversion
│   ├── parse_xml.rs      # XML parsing logic
│   ├── parse_rels.rs     # Relationship parsing logic
│   └── types.rs          # Common data types used
├── tests/
│   ├── fixtures/       # XML, Markdown, media, and presentation fixtures
│   ├── integration/    # end-to-end PPTX and ODP tests
│   └── unit/           # module-level tests

📦 Installation

Include the following line in your Cargo.toml dependencies section:

[dependencies]

pptx-to-md = "0.5.1"

📜 License

This project is licensed under the MIT-License and Apache 2.0-Licence.

Feel free to contribute or suggest improvements!