Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

kindle-periodical

Package Overview
Dependencies
Maintainers
1
Versions
23
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

kindle-periodical

create a periodical .mobi, with kindlegen

  • 1.6.6
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
4
increased by300%
Maintainers
1
Weekly downloads
 
Created
Source

kindle-periodical

create a periodical format .mobi file

Support

Buy me a Coffee

Features

  • Kindlegen will be installed automatically
  • usable as CLI and programmatically
  • support for remote webpages ( will be downloaded with node-readability ) and files
  • Markdown

How to install

npm install kindle-periodical

Kindlegen must NOT be in PATH, will be downloaded on install!

CLI usage

kindle-periodical -f nameOfBook /path/to/.json

-f --filename   name of created .mobi
-o --output     folder of created .mobi

will create a compiled folder with the generated book

API usage

var periodical = require('kindle-periodical');
var bookData = {
    "title"         : 'ebook-title',
    "creator"       : 'creator',
    "publisher"     : 'publisher',
    "subject"       : 'subject',
    "language"      : 'language (en-Gb, de-De)',
    "cover"         : "path-to-cover",
    "description"   : 'description',
    "sections"      : [{
        "title" : 'title-of-section',
        "articles"  : [{
            "title"  : 'title-of-article',
            "author" : 'author-of-article',
            "content": 'content-of-article'
            "file"   : "path-to-local-file",
            "url"    : 'url-to-a-website'
        }]
    }]
};

periodical.create(bookData, {
    targetFolder: '.' // where should the mobi file go
})
  • content supports HTML and Markdown
  • file full path to a local folder
  • url accepts a website url
  • if url or file is set, the content field will be ignored.

Keywords

FAQs

Package last updated on 17 May 2018

Did you know?

Socket

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
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc