Penman.EpubSharp 1.2.2

This package has been deprecated as it is legacy and is no longer maintained.

Suggested Alternatives

Additional Details

Penman.EpubSharp is no longer under development. For all future epub features, turn to EpubCore

dotnet add package Penman.EpubSharp --version 1.2.2

NuGet\Install-Package Penman.EpubSharp -Version 1.2.2

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="Penman.EpubSharp" Version="1.2.2" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add Penman.EpubSharp --version 1.2.2

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Penman.EpubSharp, 1.2.2"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

// Install Penman.EpubSharp as a Cake Addin
#addin nuget:?package=Penman.EpubSharp&version=1.2.2

// Install Penman.EpubSharp as a Cake Tool
#tool nuget:?package=Penman.EpubSharp&version=1.2.2

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Penman.EpubSharp

.NET 6 / .NET Standard 2.0 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");

Epub Book Builder

Use the fluent EpubBookBuilder to create your Epub.

Product	Compatible and additional computed target framework versions.
.NET	net5.0 was computed. net5.0-windows was computed. net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed.
.NET Core	netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed.
.NET Standard	netstandard2.0 is compatible. netstandard2.1 was computed.
.NET Framework	net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed.
MonoAndroid	monoandroid was computed.
MonoMac	monomac was computed.
MonoTouch	monotouch was computed.
Tizen	tizen40 was computed. tizen60 was computed.
Xamarin.iOS	xamarinios was computed.
Xamarin.Mac	xamarinmac was computed.
Xamarin.TVOS	xamarintvos was computed.
Xamarin.WatchOS	xamarinwatchos was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

.NETStandard 2.0
- No dependencies.
net6.0
- No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last updated
1.2.2	171	7/10/2023
1.2.1	165	7/9/2023
1.1.3	174	7/9/2023
1.1.0	156	7/9/2023
1.0.0	262	6/23/2022

Better fluent building and tests