Skip to content

pravinbashyal/epubinator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

epubinator

Doofenshmirtz reading to Perry the platypus

NPM package to generate full epub from a link. It uses JSDom under the hood to parse the html.



Maintainability Test Coverage

Table of Contents

Installation

yarn global add epubinator

or

npm i -g epubinator

Features

  • creates epub out of provided link
  • parses through next page for multipage websites (eg tutorials). works most of the times 😅
  • creates a navigatable table of content out of the headers for each page

Usage

$ epubinator  \
  [-m|--multiurl=boolean]  \
  [-p|--path=string] \
  [-t|--title=string] \
  [-a|--author=string] \
  url

$ epubunator [-v|--version]

example of downloading https://courses.dcs.wisc.edu/wp/readinggerman/introduction/

Options

  • -m|--multiurl=boolean (default=false): If set to true, searches for next page navigator in the page, until it no longer finds a next navigator. Each page creates an instance in table of contents with a dedicated chapter

  • -p|--path=string (default=./): The path for output file

  • -t|--title=string (default= <url of the initial link with '/' replaced with '-' and ':' removed>): Title of the book. It also sets the filename of output file.

  • -a|--author=string (default=''): Author of the book

  • -v|--version: Print the current version of package

License

MIT

About

NPM package to generate full epub from a link

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •