Reuh/feather
1
0
Fork 0
mirror of https://codeberg.org/Reuh/feather.git synced 2025-10-27 10:09:32 +00:00
Code Releases Activity

docs: update README

Browse source
This commit is contained in:
Étienne Fildadut 2025-10-17 14:55:56 +02:00
parent aad1197d5c
commit 89ab525c9d
1 changed files with 21 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -43,27 +43,41 @@ Tip: if you have nested categories, search "html" to list all the articles in th
### Marking articles as read ### Marking articles as read
Deleting an article will toggle their read status (will take effect on the next synchronization to the server). Deleting an article file will mark them as read (will take effect on the next synchronization to the server).
![Marking an article as read by deleting the article file](images/markasread.gif) ![Marking an article as read by deleting the article file](images/markasread.gif)
#### Handling read articles #### Handling read articles
The now read articles can (surprisingly) be found in the trash. If you're fast and restore them before the next synchronization, it's be as if nothing happened. However, restoring the file after synchronization will otherwise not work and the article won't be marked as unread. The now read articles can (surprisingly) be found in the trash. After marking an article as read, there is a grace period (by default 3 days) during which you can mark read articles as unread again by restoring their files from the trash.
Instead, if you want Feather to also track read articles, you could add to your configuration file: #### Reading read articles
If you want to re-read your favorites articles directly in the Feather reader director, you can configure Feather to write articles files for read articles too:
```toml ```toml
# Grab both read and unread articles into the local directory # Write article HTML files for read articles
server.only_sync_unread_articles = false [html]
write_read_articles = true
# Add a checkmark in the article filename indicating the read status # Add a checkmark in the article filename indicating the read status
html.filename_template = "{% if unread %}☐{% else %}☑{% endif %} [{{ feed_title }}]\t{{ title }} ({{ published }}).html" [html]
filename_template = "{% if unread %}☐{% else %}☑{% endif %} [{{ feed_title }}]\t{{ title }} ({{ published }}).html"
``` ```
Now both read and unread articles will be stored in the Feather reader directory, and if you delete a read article file, the article will be marked as unread (and the deleted file will be recreated during the next synchronization, but marked as unread). Now both read and unread articles will be stored in the Feather reader directory, and after marking an article file as read by deleting it, Feather will regenerate the file on the next synchronization (but marked as read this time).
Note that this also change the mark-as-unread behavior: since it is no longer possible to restore from the trash because the file is automatically recreated, marking an item as unread is done in the same way as mark-as-read, i.e. by deleting the file of a read article.
![Marking an article as unread by deleting the article file](images/markunread.gif) ![Marking an article as unread by deleting the article file](images/markunread.gif)
By default, Feather will only grab unread articles from the server, so the read articles you have access to locally are only the articles kept for the 3 days grace period after marking them as read (see the [handling read articles chapter](#handling-read-articles)). If you want to have access to _all_ articles from the server, you can add to your configuration:
```toml
# Grab both read and unread articles from the server
[server]
only_sync_unread_articles = false
```
### Synchronizing with the server ### Synchronizing with the server
Run `feather sync` to synchronize all local data with the server. The synchronization is done in two parts, which you can perform separately using: Run `feather sync` to synchronize all local data with the server. The synchronization is done in two parts, which you can perform separately using: