EpKit

An epub development toolkit. Suggestions welcome!

Epkit is both a js library and a cli tool.

• Install
• Usage
  • serve
  • zip
  • check
• Example

Install

However you plan to use epkit, you should first install it using yarn or npm.

$ npm install (-g) epkit

Example

Here's an example using the library.

const epkit = require('epkit');
 
// Serve the folder (with live reload capabilities)
epkit.serve('./ebook');
 
// Optionally, add a port number
epKit.serve('./ebook', {port: 8080});

The command-line syntax is similar.

$ epkit serve ./ebook --port=8080

Usage

Serve

Serve an unzipped epub with live reloading

(Source Code)

Parameters

• dir - relative path to folder
• options - Optional
  • port - Eg. 5500, 4000, etc. (default: 8080)
  • reload - Enable live reloading? (default: true) (coming soon!)

Zip

Convert a folder to epub format

(Source Code)

Parameters

• dir - relative path to folder

Check

Validate an epub file according to the w3 epub specs. Note that this method requires Java (1.6+) installed.

(Source Code)

Parameters

• file - relative path to file