Code Monkey home page Code Monkey logo

epubinator's Introduction

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

epubinator's People

Contributors

pravinbashyal avatar dependabot[bot] avatar github-actions[bot] avatar dependabot-preview[bot] avatar

Stargazers

Stelios Karabasakis avatar  avatar Loris Guerra avatar Rup Shri avatar Bimal Gharti Magar avatar Benjamín Simón avatar Aakash Sigdel avatar

Watchers

James Cloos avatar  avatar Rup Shri avatar

epubinator's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.