/elfeed-dashboard

A frontend for elfeed

Primary LanguageEmacs LispGNU General Public License v3.0GPL-3.0

elfeed-dashboard

https://melpa.org/packages/elfeed-dashboard-badge.svg https://img.shields.io/badge/license-GPL_v3-green.svg

A frontend for elfeed, similar to mu4e landing page. The UI can be customized with org mode.

Installation

(straight-use-package '(elfeed-dashboard :type git :host github :repo "Manoj321/elfeed-dashboard"))

With use-package

Save sample dashboard to a file

curl https://raw.githubusercontent.com/Manoj321/elfeed-dashboard/main/elfeed-dashboard.org -o ~/elfeed-dashboard.org

Install the package

(use-package elfeed-dashboard
  :ensure t
  :config (progn
            (setq elfeed-dashboard-file "~/elfeed-dashboard.org")
             ;; update feed counts on elfeed-quit
            (advice-add 'elfeed-search-quit-window :after #'elfeed-dashboard-update-links)))

Direct

Clone this repo, ex: if cloning under ~/.emacs.d/lisp/. Following config should work.

(use-package elfeed-dashboard
  :load-path "~/.emacs.d/lisp/elfeed-dashboard/"
  :config (progn
            (setq elfeed-dashboard-file "~/.emacs.d/lisp/elfeed-dashboard/elfeed-dashboard.org")
             ;; update feed counts on elfeed-quit
            (advice-add 'elfeed-search-quit-window :after #'elfeed-dashboard-update-links)))

Usage

  1. M-x elfeed-dashboard will bring up the UI
  2. “E” will let you edit in org-mode
  3. “U” will fetch new feeds. If elfeed-org is installed then it will call (elfeed-org) before fetching.
  4. Add new key maps in configuration section and call M-x elfeed-dashboard-mode to install.

License

GNU GPLv3.0

Contribute

Yes please! open github issues

Credits

Much thanks to mu4e-dashboard for inspiring me!