1
0
Fork 0
mirror of https://git.sr.ht/~rprospero/miniflux synced 2024-12-14 11:57:34 +00:00
This package connects Emacs to your favourite Miniflux server.
Find a file
2023-09-13 17:51:32 +01:00
LICENSE Add GPL v3 2023-09-13 17:10:24 +01:00
miniflux.el Better bindings in miniflux-entry-mode 2023-09-13 17:51:32 +01:00
README.md Remove wishlist from README 2023-09-13 17:17:57 +01:00
README.org Remove wishlist from README 2023-09-13 17:17:57 +01:00

This package connects Emacs to your favourite Miniflux server.

Installation

Currently, you'll need to add miniflux.el to your load-path{.verbatim}. Once this is more finalised, I'll try and get it on melpa or NonGnu ELPA.

Setup

You'll need to customise two variables:

miniflux-server{.verbatim}

The URL for the API on your miniflux server. If you're having problems and this URL doesn't end with "v1", then you probably have this wrong.

miniflux-token{.verbatim}
An API Token for your account on the server. You can create this from within Miniflux.

Usage

Running miniflux-init{.verbatim} will bring up a buffer with a tree of the categories (you may need to open "Miniflux" root category to see the categories). You can then open the categories to see the individual feeds. Each feed is marked with the number of unread messages.

Click on a feed to spawn a new buffer with all of the unread entries in that feed. You can then select an entry to read it in its entirety. From the feed buffer, you can also press "r" to mark a entry as read without actually reading it (e.g. if it looks boring).

Features

Basic HTML Support

Entries are loaded with basic HTML support (including images!) from within emacs

Sync reading with server

Entries you read in Emacs are marked as read on the server and the latest entries for a feed are just a revert-buffer{.verbatim} away.

Why isn't this just an extension to elfeed-protocol?

Elfeed-protocol does support Miniflux via the Fever API. If this works for you, keep using the battle tested code written by smart and competent people. Unfortunately, I have had bad luck with both the Fever API and elfeed, both independently and combined. I've spent more time debugging my elfeed-protocol connection to Miniflux than it took me to write this module.