diff --git a/modules/app/rss/README.org b/modules/app/rss/README.org index c5c5b5bc0..069b6170d 100644 --- a/modules/app/rss/README.org +++ b/modules/app/rss/README.org @@ -15,19 +15,20 @@ - [[#without-org][Without +org]] - [[#with-org][With +org]] - [[#keybindings][Keybindings]] + - [[#news-filtering][News filtering]] + - [[#automatically-updating-feed-when-opening-elfeed][Automatically updating feed when opening elfeed]] - [[#troubleshooting][Troubleshooting]] * Description # A summary of what this module does. -+ Read RSS feeds in comfort of DOOM (emacs) ++ Read RSS feeds in comfort of DOOM (Emacs) ** Maintainers This module has no dedicated maintainers. ** Module Flags + =+org= to enable ~elfeed-org~ to use ~org-directory/elfeed.org~ - + With [[https://github.com/remyhonig/elfeed-org][elfeed-org]] you can easily organize your feeds as you want and tag them too. ** Plugins # A list of linked plugins @@ -35,18 +36,14 @@ This module has no dedicated maintainers. + =+org= + [[https://github.com/remyhonig/elfeed-org][elfeed-org]] -** TODO Hacks +** Hacks + By default setting ~elfeed-search-filter~ is set to ~@2-week-ago~ what makes only last 2 weeks visible, to change this you can ~(setq elfeed-search-filter "")~ -+ If ~:editor evil +everywhere~ - | Key | Description | - |-----+-----------------------------| - | q | elfeed-kill-buffer | - | r | elfeed-search-update--force | * Prerequisites This module has no prerequisites. -* TODO Features +* Features ++ As there isn't currently binding for ~elfeed-update~ you can run it with ~M-x elfeed-update~ * Configuration ** Without +org @@ -56,6 +53,7 @@ When you don't want to use org mode to manage your elfeed feeds you can put your '("https://this-week-in-rust.org/rss.xml" "http://feeds.bbci.co.uk/news/rss.xml")) #+END_SRC + ** With +org When using ~+org~ flag then configuration is easier. You can use ~org-mode~ to configure feeds to follow. #+BEGIN_SRC org @@ -67,12 +65,47 @@ When using ~+org~ flag then configuration is easier. You can use ~org-mode~ to c ,**** http://feeds.bbci.co.uk/news/rss.xml #+END_SRC + 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. -+ You can "name" feeds as you please with ~org-mode~ ~org-insert-link~ and put name as you want into description. -** Keybindings -| Key | Description | -|-----+-------------| -| | | ++ 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))~ -* Troubleshooting -# Common issues and their solution, or places to look for help. +** 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-update--force | + +** 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~ +#+BEGIN_SRC elisp +(add-hook! 'elfeed-search-mode-hook 'elfeed-update) +#+END_SRC + +* TODO Troubleshooting