making ebooks better
JavaScript CSS HTML
Latest commit 82ad693 Oct 19, 2016 @owise1 owise1 committed on GitHub Merge pull request #4 from blakcap/lodash-pluck-to-map
use _.map instead of _.pluck, autorm trailing whitespace
Permalink
Failed to load latest commit information.
examples
spec
src
.gitignore
Gruntfile.js
LICENSE
Peepub.js use _.map instead of _.pluck, autorm trailing whitespace Oct 17, 2016
README.md
package.json

README.md

pe-epub

"pee pub" makes epubs better.

Our goal is to make it as easy as possible to output a valid epub. It's used in production over at The People's E-Book

JSON > EPUB

Here's the bare minimum you need to make an epub

{
	"title" : "The Peoples E-Book",
	"cover" : "http://placekitten.com/600/800",
	"pages" : [{
		"title" : "PE-EPUB",
		"body" : "Making ebooks better."
	}]
}

pe-epub assumes your assets (images, video, audio, stylesheets, javascript) are online so it will get them for you. Text assets like pages, css and js can also be passed in as strings

If you'd like to use local assets see the pe-epub-fs module

Install

npm install pe-pub

Usage

var Peepub   = require('pe-epub');
var epubJson = require('your-epub.json'); // see examples/example.json for the specs
var myPeepub = new Peepub(epubJson);

myPeepub.create('/path/to/epub/and/fileName.epub')
	.then(function(filePath){
		console.log(filePath); // the same path to your epub file!
	});

or...

myPeepub.create('/path/to/epub/')
	.then(function(filePath){
		console.log(filePath); // the same path but we made up a file name for u
	});

Testing

npm install -g jasmine-node
jasmine-node spec