doomemacs/modules/app/rss
Henrik Lissner 037b018cdd
feat: add .doommodule files
These optional dotfiles indicate the root of a module or module
group (:lang), and will later contain module metadata. They will also
serve as an alternative to packages.el and doctor.el, and will aide the
parts of the v3.0 module API concerned with resolving the current module
from a path (`doom-module-from-path`), which currently rely too heavily
on parsing path strings.

For now, however, they're simply placeholders.
2024-09-14 20:47:39 -04:00
..
.doommodule feat: add .doommodule files 2024-09-14 20:47:39 -04:00
autoload.el refactor(workspaces): +workspace/delete: rename to +workspace/kill 2024-07-05 18:05:15 -04:00
config.el feat(rss): add elfeed-tube behind +youtube 2024-08-25 17:44:29 -04:00
doctor.el feat(rss): add elfeed-tube behind +youtube 2024-08-25 17:44:29 -04:00
packages.el feat(rss): add elfeed-tube behind +youtube 2024-08-25 17:44:29 -04:00
README.org feat(rss): add elfeed-tube behind +youtube 2024-08-25 17:44:29 -04:00

:app rss

Description   unfold

Read RSS feeds in the comfort of Emacs.

Maintainers

This module has no dedicated maintainers. Become a maintainer?

Module flags

+org
Enable doom-package:elfeed-org, so you can configure your feeds with an org file ({org-directory}/elfeed.org) rather than Elisp.
+youtube
Enable doom-package:elfeed-tube, for tighter integration between elfeed and your Youtube subscriptions.

Hacks

  • By default elfeed-search-filter is set to @2-weeks-ago and makes the last 2 weeks of entries visible. This needs to be set after elfeed has loaded like so in your $DOOMDIR/config.el:

    (after! elfeed
      (setq elfeed-search-filter "@1-month-ago +unread"))

TODO Changelog

This module does not have a changelog yet.

Installation

Enable this module in your doom! block.

This module has no external requirements.

TODO Usage

󱌣 This module's usage documentation is incomplete. Complete it?

  • As there isn't currently binding for elfeed-update you can run it with M-x elfeed-update

TODO Configuration

󱌣 This module's configuration documentation is incomplete. Complete it?

Without +org

When you don't want to use org mode to manage your elfeed feeds you can put your subscriptions in $DOOMDIR/config.el:

(setq elfeed-feeds
      '("https://this-week-in-rust.org/rss.xml"
        "http://feeds.bbci.co.uk/news/rss.xml"))

With +org

When using +org flag then configuration is easier. You can use org-mode to configure feeds to follow:

* root :elfeed:
** Programming :programming:
*** [[https://this-week-in-rust.org/rss.xml][This Week in Rust]] :rust:
** News :news:
*** Top news :tops:
**** http://feeds.bbci.co.uk/news/rss.xml
  • Root of elfeed-org needs to have :elfeed: tag. This is where elfeed-org starts to read.
  • You can have subheaders as in example :programming:, and elfeed-org applies that tag to all subheader feeds, in example it adds it to This Week in Rust.
  • You can "name" feeds as you please with org-mode org-insert-link (C-c C-l) and put name as you want into description.
  • If you don't want to use org-directory/elfeed.org file you can specify it with (setq rmh-elfeed-org-files '("path/to/your/elfeed/file.org"))

Keybindings

  • General

    Key Mode Description
    S-RET elfeed-search-mode Open link into browser
    RET elfeed-search-mode Open item
    s elfeed-search-mode Filter
    C-j elfeed-show-mode Move to next item
    C-k elfeed-show-mode Move to previous item
  • If :editor evil +everywhere

    Key Description
    q elfeed-kill-buffer
    r elfeed-search-updateforce
    g c Copy link of current entry

News filtering

  • Time filtering

    • @2-days-ago Past two days
    • @2-weeks-ago Past two weeks
    • @2-years-ago Past two years
    • @2020-06-19 To show specific day
    • @2020-06-19--2020-03-10 Span of time
  • Tag filtering

    • Include +news
    • Exclude -rust
    • Both +news -rust
  • String filtering, this is case insensitive

    • Include

      • DOOM
      • Linu[sx] Search for both Linus and Linux
    • Exclude !something

Automatically updating feed when opening elfeed

Hook elfeed-update to elfeed-search-mode-hook:

(add-hook 'elfeed-search-mode-hook #'elfeed-update)

Troubleshooting

There are no known problems with this module. Report one?

Frequently asked questions

This module has no FAQs yet. Ask one?

TODO Appendix

󱌣 This module has no appendix yet. Write one?