/epub2website

Convert EPUB format ebook to Honkit&Gitbook website style

Primary LanguageCSSApache License 2.0Apache-2.0

Epub2Website - An EPUB format to website converter with Honkit&Gitbook style

Now, support convert epub to website like Honkit style.

Guide

Build binary

Need golang 1.16+

Run:

go build -o ./epub2websie cmd/epub2websie/main.go

Generate a website

Honkit&Gitbook need some static assets for web pages and plugins. By default, the https://cdn.jim.plus/ is opened to public.

Run:

./epub2website -g https://cdn.jim.plus/ -e /path/to/book.epub -o /path/to/output/epub2website

Integration with Calibre Web

  1. Update epub2website path in Basic Configuration --> External Binaries --> Path to Epub2Website Converter
  2. Update epub2website library in Basic Configuration --> External Binaries --> Epub2Website Library Endpoint Settings

More about epub2website library in Calibre Web

You can use https://cdn.jim.plus/ for default epub2website library.

All files the epub2website needed is in src.

Alternative epub2website library

You can also copy all assets in src to calibre-web/cps/static. Then set Basic Configuration --> External Binaries --> Epub2Website Library Endpoint Settings to /static/.

Confirm gitbook directory locates with calibre-web/cps/static/gitbook.

Supported plugins

All plugin should be updated in ./template/navigation.html and ./template/page.html

  • gitbook-plugin-tbfed-pagefooter
  • gitbook-plugin-back-to-top-button
  • gitbook-plugin-page-toc-button
  • gitbook-plugin-highlight
  • gitbook-plugin-search-plus
  • gitbook-plugin-fontsettings
  • gitbook-plugin-expandable-chapters
  • gitbook-plugin-splitter

Supported EPUB version

EPUB 2, EPUB 3

Licensing

Epub2Website is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.

Refer

  1. Comparison of e-book formats: https://www.w3.org/AudioVideo/ebook/
  2. EPUB 2.0.1: http://idpf.org/epub/20
  3. EPUB 3.2: https://www.w3.org/publishing/epub32/
  4. EPUB 3 Working Group: https://www.w3.org/publishing/groups/epub-wg/
  5. EPUB 3.2 Specification: https://www.w3.org/publishing/epub/epub-spec.html