https://github.com/georgjaehnig/webpages-to-ebook

Create an EPUB from a list of URLs. Standing on the shoulders of Wget, Readability and Pandoc.
https://github.com/georgjaehnig/webpages-to-ebook

ebook ebook-compliation epub epub-generation js npm pandoc wget

Last synced: about 2 months ago
JSON representation

Create an EPUB from a list of URLs. Standing on the shoulders of Wget, Readability and Pandoc.

• Host: GitHub
• URL: https://github.com/georgjaehnig/webpages-to-ebook
• Owner: georgjaehnig
• License: mit
• Created: 2017-08-29T20:34:24.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-06-12T22:58:15.000Z (7 months ago)
• Last Synced: 2024-08-04T13:05:44.787Z (5 months ago)
• Topics: ebook, ebook-compliation, epub, epub-generation, js, npm, pandoc, wget
• Language: JavaScript
• Size: 138 KB
• Stars: 190
• Watchers: 5
• Forks: 16
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Webpages to eBook

Create an EPUB from a list of URLs. Standing on the shoulders of 

> [Wget](https://www.gnu.org/software/wget/) → [Readability](https://github.com/mozilla/readability) → [Pandoc](https://pandoc.org/)

## Create your own ebooks

### Requirements

- Node.js

- NPM

- [Wget](https://www.gnu.org/software/wget/): `wget` has to be in `PATH`.

- [Pandoc](https://pandoc.org/): `pandoc` has to be in `PATH`.

### Install

    git clone https://github.com/georgjaehnig/webpages-to-ebook.git

    cd webpages-to-ebook

    npm install

### Usage

1. Create a definition, like the examples in `definitions/`.

2. `node index.js your-created-definition.yml [optional-definition-to-be-merged-with-the-first.yml]`

3. Find your EPUB in `output/epub/`.

### Documentation

- https://github.com/georgjaehnig/webpages-to-ebook/wiki/docs

## Examples

- [Slatestarcodex](https://mega.nz/folder/JZBAhSQS#Odgm1WR_SJ4zeFMl-4wvDw), based on these [definitions](definitions/).

Also some structuring with raw HTML is possible, check 

[`definitions/library_of_scott_alexandria.yml`](definitions/library_of_scott_alexandria.yml) and in there `raw:` and `tags:/title:`.