Home

📖 Welcome to the ebook-rs Wiki (v0.11.2)

ebook-rs (v0.11.2) is a high-performance, 100% pure Rust multi-format eBook engine supporting EPUB 2, EPUB 3, MOBI, AZW3 (KF8), FB2 (FictionBook 2), KEPUB (Kobo EPUB), LIT (Microsoft Reader), CBZ (Comic Book ZIP), PDF, ODT (OpenDocument Text), Plain Text (.txt), and Markdown (.md) formats with Hardened Sanitizer & Boundary Parsers, SpeechSynthesis TTS Word Synchronizer, Legacy Non-UTF-8 Charset Decoding, Automatic Language Detection, Zstd State Caching, Universal EPUB 3 Exporter, Zero-Copy mmap, Lightweight DOM AST, Fuzzy XML Recovery, Synthetic FXL Spreads, TOC Deep Search, Tree-sitter Code Parser, Readium LCP DRM, Unified Locators, Regex Search, EPUB Validation, Content Fingerprinting, and Citation Export APIs.

---

🧭 Complete Wiki Sitemap

1. Getting Started
   • Installation & Cargo Setup
   • Quick Start Code Examples across 11 Formats
   • Auto-Detecting eBook Formats
2. Multi-Format Architecture
   • How Format Parsing Works (EPUB, MOBI, FB2, LIT, CBZ, PDF, ODT, TXT, MD)
   • Asset Inlining & Data URIs
3. CFI and Locations Engine
   • EPUB Canonical Fragment Identifiers (CFI)
   • Readium Unified Locator Model (ReadiumLocator)
   • Discrete Location Chunk Indexing
4. WASM and Server Integration
   • WebAssembly Browser Bindings (wasm-bindgen)
   • Built-in Multithreaded HTTP Reader Server
5. API Reference & epub.js Parity
   • Core Book API & Multi-Format Parsers
   • Structural EPUB Validator (EpubValidator)
   • Book Fingerprinting & Deduplication (BookFingerprint)
   • Academic Citation Exporter (CitationExporter)

---

⚡ Performance & Feature Highlights

• Zero-Allocation Full-Text & Regex Search: Pre-computed search engine finding text matches in < 1ms.
• Readium Architecture Parity: Native Webpub Manifest, LCP DRM, Unified Locators, and Search API support.
• 100% Pure Rust 2024 Edition: Safe, thread-safe (Send + Sync), and cross-platform ready.