diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/configcommands.dsv | 2 | ||||
| -rw-r--r-- | doc/internal/code-style.markdown | 2 | ||||
| -rw-r--r-- | doc/newsboat.asciidoc | 19 |
3 files changed, 21 insertions, 2 deletions
diff --git a/doc/configcommands.dsv b/doc/configcommands.dsv index 609b1c34..07efa712 100644 --- a/doc/configcommands.dsv +++ b/doc/configcommands.dsv @@ -84,11 +84,13 @@ mark-as-read-on-hover||[yes/no]||no||If set to `yes`, then all articles that get max-browser-tabs||<number>||10||Set the maximum number of articles to open in a browser when using the <<open-all-unread-in-browser,`open-all-unread-in-browser`>> or <<open-all-unread-in-browser-and-mark-read,`open-all-unread-in-browser-and-mark-read`>> commands.||max-browser-tabs 4 max-download-speed||<number>||0||If set to a number greater than 0, the download speed per download is set to that limit (in KB/s).||max-download-speed 50 max-items||<number>||0||Set the maximum number of articles a feed can contain. When the threshold is crossed, old articles are dropped. If the number is set to 0, then all articles are kept.||max-items 100 +miniflux-flag-star||<flag>||""||If set and Miniflux support is used, then all articles that are flagged with the specified flag are being "starred" in Miniflux and appear in the list of "Starred items".||miniflux-flag-star "b" miniflux-login||<username>||""||Sets the username for use with Miniflux.||miniflux-login "admin" miniflux-min-items||<number>||100||This variable sets the number of articles that are loaded from Miniflux per feed.||miniflux-min-items 20 miniflux-password||<password>||""||Configures the password for use with Miniflux. Double quotes and backslashes within it <<#_using_double_quotes,should be escaped>>.||miniflux-password "here_goesAquote:\"" miniflux-passwordeval||<command>||""||A more secure alternative to the above, is providing your password from an external command that is evaluated during login. This can be used to read your password from a gpg encrypted file or your system keyring.||miniflux-passwordeval "gpg --decrypt ~/.newsboat/miniflux-password.gpg" miniflux-passwordfile||<path>||""||Another alternative, by storing your plaintext password elsewhere in your system.||miniflux-passwordfile "~/.newsboat/miniflux-pw.txt" +miniflux-show-special-feeds||[yes/no]||yes||If set and Miniflux support is used, then a "Starred items" feed (containing your starred/favourited articles) appears in your subscription list.||miniflux-show-special-feeds "no" miniflux-token||<API Token>||""||Sets the API Token for use with Miniflux.||miniflux-token "E-uTqU8r55KucuHz26tJbXfrZVRndwY_mZAsEfcC8Bg=" miniflux-tokeneval||<command>||""||A more secure alternative to the above, is providing your API token from an external command that is evaluated during login. This can be used to read your token from a gpg encrypted file or your system keyring.||miniflux-tokeneval "gpg --decrypt ~/.newsboat/miniflux-token.gpg" miniflux-tokenfile||<API Token>||""||Another alternative, by storing your plaintext token elsewhere in your system.||miniflux-tokenfile "~/.newsboat/miniflux-token.txt" diff --git a/doc/internal/code-style.markdown b/doc/internal/code-style.markdown index 65508fe9..f65eca0a 100644 --- a/doc/internal/code-style.markdown +++ b/doc/internal/code-style.markdown @@ -23,6 +23,8 @@ Guidelines that could be easily automated, have been. Please install: You can then run `make fmt` to format both C++ and Rust code. +Note: If you are running into issues running `make fmt` locally, there is a lightweight Docker container available you can use to format. Instructions are in the [Docker file](../../docker/code-formatting-tools.dockerfile). + [editorconfig]: https://editorconfig.org/ "EditorConfig" [astyle]: http://astyle.sourceforge.net/ "Artistic Style" diff --git a/doc/newsboat.asciidoc b/doc/newsboat.asciidoc index 8d1cb0c5..47d9a4b4 100644 --- a/doc/newsboat.asciidoc +++ b/doc/newsboat.asciidoc @@ -684,8 +684,23 @@ It is also possible to specify an API token instead of the username/password com See also <<miniflux-tokenfile,`miniflux-tokenfile`>>, and <<miniflux-tokeneval,`miniflux-tokeneval`>>. -Unlike with other backends, Miniflux's starring/bookmarking feature is not -currently supported in Newsboat. +In addition, Miniflux provides the ability to "star" +articles. Starred articles are basically bookmarks. Newsboat allows the +use of this feature by mapping its powerful "flags" to the "star"/"unstar" +operations. + +In order to use this mapping, all you need to do is to configure the flags +that shall be used: + + miniflux-flag-star "a" + +After that, use these flags when you edit flags for an article, and these +articles will be starred. + +By default a "Starred Items" feed is included in the feed list. This can be +removed with: + + miniflux-show-special-feeds "no" Miniflux categories are converted into Newsboat tags. You can select and filter feeds by tags; see <<_tagging>> and <<_filter_language>> for details. |