Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 

README.md

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.

About

Doc scraper and ebook generator / library.

Resources

Releases

No releases published

Packages

No packages published
You can’t perform that action at this time.