Socket
Socket
Sign inDemoInstall

epkit

Package Overview
Dependencies
668
Maintainers
1
Versions
2
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    epkit

A complete epub development kit


Version published
Maintainers
1
Created

Readme

Source

EpKit

An epub development toolkit. Suggestions welcome!

Version Downloads/week License

Epkit is both a js library and a cli tool.

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

Keywords

FAQs

Last updated on 27 Jan 2020

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