CLI tool to simplify building EPUB's

David Herron 3e3af13da9 Implement dc:identifiers import and export 11 months ago
example 71b56c493c Many more fields supported 1 year ago
.gitignore 384ce33f7c Initial release 1 year ago
Configuration.js 5e3b30b067 Implement import command 1 year ago
README.md f9e46da7e3 Update docs 1 year ago
bundleEPUB.js 59ef6fdd60 Move functions to own module 1 year ago
cli.js 5e3b30b067 Implement import command 1 year ago
index.js 3e3af13da9 Implement dc:identifiers import and export 11 months ago
manifest.js e59080d396 Support adding items to Manifest 1 year ago
metadata.js 59ef6fdd60 Move functions to own module 1 year ago
opf.js 3e3af13da9 Implement dc:identifiers import and export 11 months ago
package.json c2e8d6af0d Adjust dependencies 1 year ago
utils.js 384ce33f7c Initial release 1 year ago

README.md

EPUBTools - complete toolset for building, extracting and manipulating EPUB3 packages

The purposes for this package include:

  • Generating an EPUB3 package from a directory structure containing files conforming to the EPUB3 standard
  • Assisting with generating the metadata files required by EPUB3
  • Extracting an EPUB3 to a directory

Installation:

$ npm install epubtools --save

This package provides both an API and a CLI tool.

To facilitate using the CLI tool, add ./node_modules/.bin to your PATH variable. By doing so you can easily run any CLI tool installed by a Node.js package.

CLI

To get help run: epubtools --help

$ epubtools package configFileFN

Package the EPUB described by the configuration file.

$ epubtools unpack file-name.epub

Unpacks the given EPUB file. TODO this command does not work as advertised

$ epubtools import path/to/EPUB/directory config.epubtools

Reads information from the OPF file in the EPUB directory, and constructs the configuration file.

Configuration file

Configuration files are named with the extension .epubtools. They are in YAML format, and describe some EPUB3 metadata and other information required to build an EPUB3 package.