README

html2epub

Convert a collection of HTML documents into an IDPF-compliant EPUB3 document.

Along with an HTML editor, this can be used as a lightweight alternative to EPUB authoring systems (e.g. Calibre, Sigil…) to generate either tables of contents, OPF files, or complete EPUB3 books.

This script can also be used to extract online web content and make a local EPUB archive for offline reading.

Installation

npm install html2epub -g

Basic usage

html2epub
  [ --config=/path/to/config.json      configuration file                          ]
  [ --basedir=/path/to/directory       base directory (default: current directory) ]
  [ --format=txt|json|xhtml|ncx|epub   output format  (default: epub)              ]
  [ --headings="CSS selector"          ToC headings   (default: h1,h2,h3,h4,h5,h6) ]
  [ --depth                            ToC depth      (default: 3)                 ]

Check the examples directory for sample configuration files.

License

the code is released under the MIT license
in the examples folder, alice is subject to the Gutenberg™ license

Stability

This works quite well but it’s still in a very early stage: the API and the command-line arguments are likely to change in the near future.

Alternatives

Here are a few other HTML-to-EPUB solutions that could suit your needs:

Note: if you only need to store a web page in a single file, wget64 is a good alternative to EPUB documents.

Usage no npm install needed!