doomemacs/modules/app/rss
Henrik Lissner ad6a3d0f33
refactor: deprecate featurep! for modulep!
featurep! will be renamed modulep! in the future, so it's been
deprecated. They have identical interfaces, and can be replaced without
issue.

featurep! was never quite the right name for this macro. It implied that
it had some connection to featurep, which it doesn't (only that it was
similar in purpose; still, Doom modules are not features). To undo such
implications and be consistent with its namespace (and since we're
heading into a storm of breaking changes with the v3 release anyway),
now was the best opportunity to begin the transition.
2022-08-14 20:43:35 +02:00
..
autoload.el refactor: deprecate featurep! for modulep! 2022-08-14 20:43:35 +02:00
config.el refactor: deprecate featurep! for modulep! 2022-08-14 20:43:35 +02:00
packages.el refactor: deprecate featurep! for modulep! 2022-08-14 20:43:35 +02:00
README.org revert: fix(docs): set mode in file-local vars 2022-08-07 19:08:07 +02: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 elfeed-org, so you can configure your feeds with an org file ({org-directory}/elfeed.org) rather than Elisp.

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?