Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fabi1cazenave/node-html2epub
Convert a bunch of HTML documents into an EPUB
https://github.com/fabi1cazenave/node-html2epub
Last synced: about 1 month ago
JSON representation
Convert a bunch of HTML documents into an EPUB
- Host: GitHub
- URL: https://github.com/fabi1cazenave/node-html2epub
- Owner: fabi1cazenave
- License: mit
- Created: 2014-11-20T17:56:53.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2021-07-09T17:16:12.000Z (over 3 years ago)
- Last Synced: 2024-10-05T09:40:54.949Z (about 2 months ago)
- Language: JavaScript
- Size: 603 KB
- Stars: 36
- Watchers: 4
- Forks: 10
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
html2epub
=========
Convert a collection of HTML documents into an [IDPF-compliant](http://validator.idpf.org/)
EPUB3 document.
[](https://nodei.co/npm/html2epub/)
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](https://github.com/fabi1cazenave/node-ebook/tree/master/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](http://gutenberg.org/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:
* [aov-html2epub](https://github.com/angelortega/aov-html2epub)
* [ebook-convert](http://manual.calibre-ebook.com/cli/ebook-convert.html)
* [GrabMyBooks](https://addons.mozilla.org/en-US/firefox/addon/grabmybooks/)
Note: if you only need to store a web page in a single file,
[wget64](https://www.npmjs.org/package/wget64) is a good alternative to EPUB
documents.