- Documented API
- Creates valid EPUB 3.0 files
- Adds an additional EPUB 2.0 table of contents for maximum compatibility
- Includes support for adding CSS, images, and fonts
Contributions are welcome; please see CONTRIBUTING.md for more information.
Clone this repository using Git. Run tests as documented below.
Dependencies are managed using Go modules
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:
-
Make sure you have Java installed on your system
-
Get the latest version of EPUBCheck from https://github.com/w3c/epubcheck/releases
-
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:
-
Set
doCleanup = false
in epub_test.go -
Run the tests (see below)
-
Upload the generated
My EPUB.epub
file to https://validator.idpf.org/
go test