---

⚠️ This project is unmaintained. Please use go-shiori/go-epub or another fork.

Features

• Documented API
• Creates valid EPUB 3.0 files
• Adds an additional EPUB 2.0 table of contents (as seen here) for maximum compatibility
• Includes support for adding CSS, images, and fonts

For an example of actual usage, see https://github.com/bmaupin/go-docs-epub

Contributions

Contributions are welcome; please see CONTRIBUTING.md for more information.

Development

Clone this repository using Git. Run tests as documented below.

Dependencies are managed using Go modules

Testing

EPUBCheck

EPUBCheck is a tool that will check an EPUB for validation errors.

If EPUBCheck is installed locally, it will be run alongside the Go tests. To install EPUBCheck:

1. Make sure you have Java installed on your system

2. Get the latest version of EPUBCheck from https://github.com/w3c/epubcheck/releases

3. Download and extract EPUBCheck in the root directory of this project, e.g.

   wget https://github.com/IDPF/epubcheck/releases/download/v4.2.5/epubcheck-4.2.5.zip
   unzip epubcheck-4.2.5.zip
   

If you do not wish to install EPUBCheck locally, you can manually validate the EPUB:

1. Set doCleanup = false in epub_test.go

2. Run the tests (see below)

3. Upload the generated My EPUB.epub file to http://validator.idpf.org/

Run tests

go test