Giter Club home page Giter Club logo

epublifier's Introduction

Epublifier

Fans of eReaders and Kindle can use this tool to generate eReader/Kindle compatible files from websites to read later.

An extremely customizable tool that allows you to extract a list of html pages from a table of content page and compile them into an ePub book to be imported into your eReader of choice.

For advanced users who can write javascript, you can add additional parser definition to customize parsing of any site.

Features

  • Support novels with many chapters (tested up to 300 chapters)
  • Downloads and embeds images
  • Can selectively parse chapters by using shift-select
  • Automatically catches main content with readability.js
  • Cover image, author, title, description are auto-parsed from some sites.
    • Novel Updates
  • Configurable parsers for table of contents and chapters

How to Use

  • Install the extension
  • Navigate to a table of content page
    • Example: https://www.novelupdates.com/series/<series>
    • ๐Ÿ›ˆ (For novelupdates) Click on the โ˜ฐ menu button (Show all chapters) above the chapter list
  • Click Epublifier's icon on your browser's extension bar, which will open a popup. It will automatically try to load the series' metadata.
  • Click Load Chapter List, which will create a new tab
  • Select some chapters (or all of them)
    • ๐Ÿ›ˆ You may use Shift+Click to select a range of chapters to include or delete.
  • Click Extract Chapters, if all is well, it should say Parsed if parser worked
  • Click Compile Epub to generate the ePub as a download

Advanced User Configurations

Warning: Advanced configuration requires javascript knowledge

Overview

There are four configurations for advanced users:

  • Table of Content Auto detector - Changes which TOC parser to use depending on page source and URL
  • Table of Content parsers - Actually parses HTML into list of chapter URLs or chapter htmls
  • Chapter Type Auto Detector - Detects what kindof chapter parser to use depending on page source and URL
  • Chapter Parser - Parses a chapter HTML text into text only HTML content

Configuring a parser

You can either create a new YAML parser definition or modify the existing main definition.

Building

Build Environment

  • Windows 10
  • NPM version 8.1.2

Build Steps

  • Install NPM
  • Run npm install in base directory
  • Run npm run build_ff for Firefox
  • Run npm run build for Chrome

CI/CD

Acknowledgements

  1. jEpub

epublifier's People

Contributors

maoserr avatar dependabot[bot] avatar github-actions[bot] avatar mchubby avatar

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.