GitPlanet

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

Created with love in Canada, visit hostnodejs.com today

Feel like to post an Ad? Learn Details
All Projects → javierbyte → Docs2epub

javierbyte / Docs2epub

Doc scraper and ebook generator / library. [unmaintained]

Programming Languages

javascript
184084 projects - #8 most used programming language

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.

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].