GithubHelp home page GithubHelp logo

jpwelsh2500 / hfy2epub Goto Github PK

View Code? Open in Web Editor NEW

This project forked from hacst/hfy2epub

0.0 0.0 0.0 436 KB

A tool to turn post series from r/HFY to EPUB files in your browser

License: MIT License

JavaScript 82.96% HTML 17.04%

hfy2epub's Introduction

hfy2epub

hfy2epub is web-tool to turn post series from reddit.com/r/HFY into EPUB files for easy offline consumption with a reader or text-to-speech.

All work to identify the posts, fetch them and turn them into an epub are performed in the browser with no server component required.

Features

  • Can retrieve series information from HFY wiki pages or by following the next links starting from an initial post
  • Supports NSFW tagged posts
  • Completely in-browser. No installation required. No data transmitted to or from server.
  • Should work in all modern browsers

Usage

Before you do anything with this tool be aware that you must not distribute the epub files created by this tool if the author has not given you permission to do so. In general respect the author's wishes and do not use this tool if the author is not ok with it. When in doubt ask the author.

With that out of the way using hfy2epub is quite straight-forward. After opening index.html in your browser all you need is the URL of a HFY wiki page listing the parts of a series or the first post of a series that links to future posts with next links.

After providing that URL press the "Retrieve series info". This will try to populate title, author as well as the list of parts in the "Series information" section. Review the information and correct as needed.

Once that is completed press the "Download EPUB" button and the tool will fetch any posts not already retrieved, create the EPUB and trigger the download to you.

Limitations

This tool has no ambitions to do everything for everyone. Series information detection is based on a some very weak heuristics like links with specific names being present, titles being set in a specific way and so on. It will not work for everything and everyone.

Also this tool makes no attempt to create an especially pretty EPUB. It simply slaps the HTML of first post of each detected part of the series into the EPUB. It is meant for reading not distribution.

Safari earlier than version 10.1 is not compatible with this tool due to limitations in file download handling.

For authors

While we are very explicit about the user having to ensure the author is ok with it before using this tool and consider any EPUBs created the user's responsibility we have some limited ways to further discourage the use of the tool on your content. If you are an HFY author and do not want this tool to process your posts you can include the text "[NOEPUB]" in the title or content of your post to make the tool refuse to process it. Alternatively you can create an issue on github and we can blacklist your username. Note that this can not stop someone willing to edit the code to remove the block.

hfy2epub's People

Contributors

hacst 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.