docspec

Streaming document conversion. Convenience facade re-exporting the DocSpec readers, writers, and core event types.

Use this crate when you want a single entry point. For the smallest possible dependency footprint, depend directly on the individual sub-crates (docspec-core, docspec-markdown-reader, etc.) instead.

Usage

[dependencies]
docspec = { version = "0.5", features = ["markdown", "blocknote"] }

use docspec::readers::MarkdownReader;
use docspec::writers::BlockNoteWriter;
use docspec::{EventSink, EventSource, StackTrackingSink};

let markdown = "# Hello\n\nWorld";
let mut reader = MarkdownReader::new(markdown);
let mut buf = Vec::<u8>::new();
let mut writer = StackTrackingSink::new(BlockNoteWriter::new(&mut buf));

while let Some(event) = reader.next_event()? {
    writer.handle_event(event)?;
}
writer.finish()?;

Feature Flags

Readers

DocxReader takes a file path or Read + Seek source (not &str), so it cannot be dispatched through the text-based AnyReader factory. Construct it directly with DocxReader::from_path or DocxReader::from_reader.

Writers

Primitives

Convenience

No features are enabled by default — opt into what you need.

Documentation

See the main DocSpec repository for the full project documentation, architecture, and event protocol.