https://github.com/moszeed/kindle-periodical

create a periodical .mobi, with kindlegen
https://github.com/moszeed/kindle-periodical

javascript kindle kindlegen mobi nodejs npm perioidical

Last synced: 2 months ago
JSON representation

create a periodical .mobi, with kindlegen

• Host: GitHub
• URL: https://github.com/moszeed/kindle-periodical
• Owner: moszeed
• Created: 2014-09-10T12:04:07.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2021-06-27T20:41:39.000Z (over 3 years ago)
• Last Synced: 2024-11-10T21:06:06.966Z (2 months ago)
• Topics: javascript, kindle, kindlegen, mobi, nodejs, npm, perioidical
• Language: JavaScript
• Size: 50.8 KB
• Stars: 41
• Watchers: 3
• Forks: 10
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# kindle-periodical

create a periodical format .mobi file

##### Support

[Buy me a Coffee](https://www.patreon.com/moszeed)

### Features

* Kindlegen will be installed **automatically**

* usable as **CLI** and **programmatically**

* support for **remote webpages** ( will be downloaded with [node-readability](https://github.com/luin/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.