Socket
Socket
Sign inDemoInstall

pe-epub

Package Overview
Dependencies
51
Maintainers
1
Versions
38
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    pe-epub

JSON to EPUB


Version published
Weekly downloads
40
increased by135.29%
Maintainers
1
Install size
11.2 MB
Created
Weekly downloads
 

Readme

Source

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

FAQs

Last updated on 24 Feb 2015

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc