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 = "1.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::from_str(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 is dispatched through AnyReader::from_reader and AnyReader::from_path. Use AnyReader::from_path(InputFormat::Docx, path) to open a DOCX file, or AnyReader::from_reader(InputFormat::Docx, cursor) to read from an in-memory buffer.

use docspec::{AnyReader, InputFormat};

# fn main() -> docspec::Result<()> {
let reader = AnyReader::from_path(InputFormat::Docx, "document.docx")?;
# Ok(())
# }

Writers

Primitives

Convenience

Default features are markdown, blocknote, and pandoc-native; disable default features when you need the smallest possible dependency footprint.

Documentation

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