Penman.EpubSharp 1.0.0

Penman.EpubSharp

.NET library for reading and writing EPUB files. An upgrade of asido/EpubSharp

Supported EPUB versions: 2.0, 3.0, 3.1

Installation

Install-Package Penman.EpubSharp

Supported Frameworks

.NET6.0, .NETSTANDARD2.0

Usage

Reading an EPUB

// Read an epub file
EpubBook book = EpubReader.Read("my.epub");

// Read metadata
string title = book.Title;
string[] authors = book.Authors;
Image cover = book.CoverImage;

// Get table of contents
ICollection<EpubChapter> chapters = book.TableOfContents;

// Get contained files
ICollection<EpubTextFile> html = book.Resources.Html;
ICollection<EpubTextFile> css = book.Resources.Css;
ICollection<EpubByteFile> images = book.Resources.Images;
ICollection<EpubByteFile> fonts = book.Resources.Fonts;

// Convert to plain text
string text = book.ToPlainText();

// Access internal EPUB format specific data structures.
EpubFormat format = book.Format;
OcfDocument ocf = format.Ocf;
OpfDocument opf = format.Opf;
NcxDocument ncx = format.Ncx;
NavDocument nav = format.Nav;

// Create an EPUB
EpubWriter.Write(book, "new.epub");

Writing an EPUB

Editing capabilities are currently very limited and might not work at all. Use it at your own risk. The next release will bring a true write support.

EpubWriter writer = new EpubWriter();

writer.AddAuthor("Foo Bar");
writer.SetCover(imgData, ImageFormat.Png);

writer.Write("new.epub");