Giter VIP home page Giter VIP logo

epub2website's Introduction

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 ./epub2website cmd/epub2website/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

or you can use resource file in this repo

cd /src/epub2website
./epub2website -g ../../../src/ -e ./ebooks/raw/'Breathless_David Quammen.epub' -o ./ebooks/web/'Breathless_David Quammen.epub'

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

epub2website's People

Contributors

hailongchang avatar jim3ma avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.