zsoltika / omnivore-epub

A program to generate epub files from your unarchived Omnivore articles

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Omnivore EPUB

A program to generate epub files from your unarchived Omnivore articles.

Forked from here

Usage

  • Install Deno
  • Get an API token for Omnivore following instructions here
  • Put your token in the token field in config file
  • Modify the configuration file if necessary
  • In your terminal, go to the app folder and run the following command deno run -A main.ts
  • The ebook with extension .epub should be in the app directory after execution

Configuration

Configuration options available in the config file

Option Type Description
token string Omnivore API Token
endpoint string Omnivore GraphQL API endpoint
title string Title of the ebook
author string Author of the ebook
cover string URL for fetching cover image for the ebook
description string Description of the ebook
addLabelsInContent boolean Whether to add the labels for the article below title
addArticleLinkInContent boolean Whether to add the link for the article below title
allowImages boolean Whether to add images linked in article in the ebook
outputFileName string Ebook file name
maxArticleCount number Number of articles to fetch
searchQuery string Valid query for article search, default: "sort:saved-desc". Change it to "sort:saved-asc" for fetching oldest articles first
ignoredLabels string[] List of labels to exclude from the ebook
ignoredLinks string[] List of urls to exclude from the ebook

About

A program to generate epub files from your unarchived Omnivore articles

License:MIT License


Languages

Language:TypeScript 100.0%