@annadamm/scribblehub-to-epub v3.0.0-1

Scribblehub-to-epub

This program scrapes a single story of Scribblehub and exports it as a book in epub format. The epub can be read by most ebook readers, such as Kindle.

Installation

npm install -g @annadamm/scribblehub-to-epub

Usage

scribblehub-to-epub <scribblehub-url>
# get all available options:
scribblehub-to-epub --help

<scribblehub-url> refers to the main page of a story, looking like this: https://www.scribblehub.com/series/<id>/<name>/, e.g: https://www.scribblehub.com/series/36420/the-fastest-man-alive/.

All CLI Parameters

Usage: scribble-to-epub [options] <url> [out-file]

Downloads a book from scribblehub.com and outputs it as an epub file

Arguments:
  url                         base url of the Scribble Hub series, e.g. "https://www.scribblehub.com/series/36420/the-fastest-man-alive/"
  out-file                    file name of the generated epub, defaults to "dist/<book-url-slug>.epub"

Options:
  -V, --version               output the version number
  -s, --start-with <chapter>  Chapter index to start with (default: 1)
  -e, --end-with <chapter>    Chapter index to end with, defaults to the end of the book
  -o, --overwrite             overwrite the [out-file] if it already exists
  -O, --no-overwrite          do not overwrite the [out-file] if it already exists
  -P, --no-progress           do not show a progress bar
  -v, --verbose               verbosity that can be increased (-v, -vv, -vvv)
  -q, --quiet                 do not output anything (default: false)
  --cache-dir <dir>           Cache directory (default: "~/node_modules/.cache/scribblehub-to-epub")
  -h, --help                  display help for command

Report bugs and feature requests

Report any bugs and feature requests on GitHub Issues

Contribute

Clone GitHub and install dependencies:

git clone https://github.com/AnnaDamm/scribblehub-to-epub.git
cd scribblehub-to-epub
npm ci