{"id":20226042,"url":"https://github.com/moszeed/kindle-periodical","last_synced_at":"2025-10-27T22:16:40.342Z","repository":{"id":20592121,"uuid":"23872894","full_name":"moszeed/kindle-periodical","owner":"moszeed","description":"create a periodical .mobi, with kindlegen","archived":false,"fork":false,"pushed_at":"2021-06-27T20:41:39.000Z","size":52,"stargazers_count":43,"open_issues_count":2,"forks_count":9,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-24T14:46:23.359Z","etag":null,"topics":["javascript","kindle","kindlegen","mobi","nodejs","npm","perioidical"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/moszeed.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-09-10T12:04:07.000Z","updated_at":"2025-01-28T20:24:07.000Z","dependencies_parsed_at":"2022-08-21T19:41:00.238Z","dependency_job_id":null,"html_url":"https://github.com/moszeed/kindle-periodical","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moszeed%2Fkindle-periodical","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moszeed%2Fkindle-periodical/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moszeed%2Fkindle-periodical/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moszeed%2Fkindle-periodical/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/moszeed","download_url":"https://codeload.github.com/moszeed/kindle-periodical/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248198871,"owners_count":21063626,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["javascript","kindle","kindlegen","mobi","nodejs","npm","perioidical"],"created_at":"2024-11-14T07:15:54.822Z","updated_at":"2025-10-27T22:16:35.308Z","avatar_url":"https://github.com/moszeed.png","language":"JavaScript","funding_links":["https://www.patreon.com/moszeed"],"categories":[],"sub_categories":[],"readme":"# kindle-periodical\ncreate a periodical format .mobi file\n\n##### Support\n\n[Buy me a Coffee](https://www.patreon.com/moszeed)\n\n### Features\n* Kindlegen will be installed **automatically**\n* usable as **CLI** and **programmatically**\n* support for **remote webpages** ( will be downloaded with [node-readability](https://github.com/luin/readability) ) and **files**\n* **Markdown**\n\n### How to install\n    npm install kindle-periodical\n\nKindlegen must **NOT** be in PATH, will be downloaded on install!\n\n### CLI usage\n    kindle-periodical -f nameOfBook /path/to/.json\n    \n    -f --filename   name of created .mobi\n    -o --output     folder of created .mobi\n\nwill create a ```compiled``` folder with the generated book\n\n### API usage\n\n    var periodical = require('kindle-periodical');\n    var bookData = {\n        \"title\"         : 'ebook-title',\n        \"creator\"       : 'creator',\n        \"publisher\"     : 'publisher',\n        \"subject\"       : 'subject',\n        \"language\"      : 'language (en-Gb, de-De)',\n        \"cover\"         : \"path-to-cover\",\n        \"description\"   : 'description',\n        \"sections\"      : [{\n            \"title\" : 'title-of-section',\n            \"articles\"  : [{\n                \"title\"  : 'title-of-article',\n                \"author\" : 'author-of-article',\n                \"content\": 'content-of-article'\n                \"file\"   : \"path-to-local-file\",\n                \"url\"    : 'url-to-a-website'\n            }]\n        }]\n    };\n    \n    periodical.create(bookData, {\n        targetFolder: '.' // where should the mobi file go\n    })\n\n\n- ```content``` supports HTML and Markdown\n- ```file``` full path to a local folder\n- ```url``` accepts a website url\n- if ```url``` or ```file``` is set, the ```content``` field will be ignored.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmoszeed%2Fkindle-periodical","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmoszeed%2Fkindle-periodical","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmoszeed%2Fkindle-periodical/lists"}