Giter Site home page Giter Site logo

docs2epub's Introduction

Get your favorite docs as ebooks! Doc scraper and ebook generator.

docs2epub

Library

List of precompiled ebooks created with docs2epub.

Generate your own ebook form docs

The objective of this tool is to be a ready to go documentation parser and ebook generator (from scraping documentation sites or markdown).

It has a central processing and epub generator based on strategies.

If you want to add your own ebook generator you'll have to add a 'strategy' to the the /src/strategies/ dir that returns a docObj object as described on tocToArray.js. And then require it on run.js.

Then run

  node index.js --project <yourprojectid>

With yourprojectid being the key on the run.js require.

And you'll have your .epub on the docs/downloads directory!

Remember to add the original documentation licence. And feel free to open an issue here or create a PR if you want to add your generated ebook to the library.

Features

  • Pluggable system to add more documentation sources.
  • Uses epub-gen tuned for code.

Future improvements

  • Easier and smarter way to add more documentation sources.
  • Cronjob to auto-update library.

Licence

MIT.

docs2epub's People

Contributors

javierbyte avatar

Watchers

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.