sqrtminusone/elfeed-summary
1
0
Fork 0
mirror of https://github.com/SqrtMinusOne/elfeed-summary.git synced 2025-12-10 09:43:02 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: action table in the readme

Browse source
This commit is contained in:
Pavel Korytov 2022-03-26 11:51:09 +03:00
parent dccfebb1a2
commit cd074dd18f
1 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.org
View file

@ -1,6 +1,6 @@
#+TITLE: elfeed-summary
The package provides a tree-based feed summary interface for [[https://github.com/skeeto/elfeed][elfeed]]. The tree can include individual feeds, [[https://github.com/skeeto/elfeed#filter-syntax][searches]], and groups. It mainly serves as an easier "jumping point" for elfeed, so searching a subset of the elfeed database is one action away.
The package provides a tree-based feed summary interface for [[https://github.com/skeeto/elfeed][elfeed]]. The tree can include individual feeds, [[https://github.com/skeeto/elfeed#filter-syntax][searches]], and groups. It mainly serves as an easier "jumping point" for elfeed, so to make querying a subset of the elfeed database is one action away.
Inspired by [[https://github.com/newsboat/newsboat][newsboat]].
@ -24,17 +24,17 @@ The tree consists of:
Available keybindings in the summary mode:
| Keybinding | Description |
|------------+----------------------------------------------------------|
| =RET= | Open thing under the cursor (a feed, search, or a group) |
| =M-RET= | Open thing under the cursor, but include unread items |
| =q= | Quit the summary |
| =r= | Refresh the summary buffer |
| =R= | Run update for elfeed feeds |
| =u= | Toggle showing only unread entries |
| =U= | Mark everything in the entry under the cursor as read |
| Keybinding | Command | Description |
|------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------|
| =RET= | =elfeed-summary--action= | Open thing under the cursor (a feed, search, or a group). If there is at least one unread item, it will show only unread items. |
| =M-RET= | =elfeed-summary--action-show-read= | Open thing under the cursor, but always include read items |
| =q= | ... | Quit the summary buffer |
| =r= | =elfeed-summary--refresh= | Refresh the summary buffer |
| =R= | =elfeed-summary-update= | Run update for elfeed feeds |
| =u= | =elfeed-summary-toggle-only-unread= | Toggle showing only unread entries |
| =U= | =elfeed-summary--action-mark-read= | Mark everything in the entry under the cursor as read |
The standard keybindings from [[https://magit.vc/manual/magit.html#Sections][magit-section]] are also available, for instance =TAB= to toggle the visibility of the current group. [[https://github.com/emacs-evil/evil][evil-mode]] is also supported.
The standard keybindings from [[https://magit.vc/manual/magit.html#Sections][magit-section]] are also available, for instance =TAB= toggles the visibility of the current group. [[https://github.com/emacs-evil/evil][evil-mode]] is also supported.
* Configuration
** Tree configuration