diff --git a/_config.yml b/_config.yml index ce4a0b7..2706742 100644 --- a/_config.yml +++ b/_config.yml @@ -38,6 +38,23 @@ aux_links: "Report Issue": - "https://github.com/tt-rss/tt-rss/issues" +# Callouts +callouts: + highlight: + color: yellow + important: + title: Important + color: blue + new: + title: New + color: green + note: + title: Note + color: purple + warning: + title: Warning + color: red + # Markdown settings markdown: kramdown kramdown: diff --git a/docs/Android-Client.md b/docs/Android-Client.md index a9a907a..e7f9559 100644 --- a/docs/Android-Client.md +++ b/docs/Android-Client.md @@ -30,7 +30,7 @@ nav_order: 40 Releases are built automatically for every commit pushed to master branch and [published on Gitlab](https://gitlab.tt-rss.org/tt-rss/tt-rss-android/-/releases). -> [!WARNING] +{: .warning } > This is the only official and supported way to get the APK. If you see the app on any marketplace or anywhere else, it had been uploaded there without my knowledge or consent. Release APKs are signed. You can verify the signature using [apksigner](https://developer.android.com/tools/apksigner): diff --git a/docs/Archived-Feed.md b/docs/Archived-Feed.md index 86319d4..43c0fdf 100644 --- a/docs/Archived-Feed.md +++ b/docs/Archived-Feed.md @@ -7,6 +7,6 @@ nav_order: 41 Archived is the place for articles for which originating feed no longer exists. It's either Starred articles from unsubscribed feeds or [externally shared data](Share-Anything). -> [!NOTE] +{: .note } > Articles in Archived feed are not expired automatically, you can delete them manually > using `Select...` → `Delete permanently` in the main toolbar. diff --git a/docs/Content-Filters.md b/docs/Content-Filters.md index 6ad1408..282ed7c 100644 --- a/docs/Content-Filters.md +++ b/docs/Content-Filters.md @@ -13,7 +13,7 @@ Matching is case-insensitive, [PCRE](http://php.net/manual/en/reference.pcre.pattern.syntax.php) pattern syntax is used. -> [!NOTE] +{: .note } > Filter test dialog may not give entirely accurate results, especially for > complex filters. It is suggested to test filters using ``Feed debugger`` (hotkey `f-D`) if you > feel that some filter is somehow misfiring on a specific feed. @@ -44,7 +44,7 @@ expressions. Filter matching is performed during feed processing. -> [!NOTE] +{: .note } > Some actions may be applied only when the article is initially imported from the > feed. Other actions may be applied every time article is seen in the originating > feed. It is suggested to only rely on filters applying to articles imported @@ -53,7 +53,7 @@ Filter matching is performed during feed processing. Several actions are available: -> [!WARNING] +{: .warning } > Filters may not apply actions conditionally based on previous filters. All actions for an article are applied together, once. 1. ``Delete article`` - do not import article from the feed, does not diff --git a/docs/Email-Digests.md b/docs/Email-Digests.md index e224d8d..17f84d7 100644 --- a/docs/Email-Digests.md +++ b/docs/Email-Digests.md @@ -9,7 +9,7 @@ Users may opt into receiving daily (sent once every 24-hours) digests of unread Digests are sent out by the update daemon or if running update.php —feeds manually. At most 15 messages are sent in one batch. -> [!NOTE] +{: .note } > [PHPMailer plugin](https://github.com/tt-rss/tt-rss-plugin-mailer-smtp) is required to send mail under Docker. diff --git a/docs/Encryption.md b/docs/Encryption.md index 74e1172..b4c9207 100644 --- a/docs/Encryption.md +++ b/docs/Encryption.md @@ -14,5 +14,5 @@ php ./update.php --gen-encryption-key If enabled, existing plaintext login sessions are automatically encrypted when used, plaintext feed passwords are encrypted on feed update. -> [!WARNING] +{: .warning } > Automatic encryption of plaintext data is a one-way process. If you decide to disable `TTRSS_ENCRYPTION_KEY` afterwards, all encrypted sessions would become invalid and you will get logged out. Feed passwords would become unreadable until you either enable encryption back using same key or edit feeds manually. diff --git a/docs/FAQ.md b/docs/FAQ.md index 9a274a7..7363506 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -4,7 +4,7 @@ title: FAQ nav_order: 30 --- -> [!NOTE] +{: .note } > [Docker-related stuff is on a separate page](Installation-Guide#faq) ### I want to check how tt-rss renders my feed / the feed I'm trying to use is parsed incorrectly diff --git a/docs/Feed-Handler-Plugins.md b/docs/Feed-Handler-Plugins.md index acb7ac2..449729c 100644 --- a/docs/Feed-Handler-Plugins.md +++ b/docs/Feed-Handler-Plugins.md @@ -4,7 +4,7 @@ title: Feed Handler Plugins nav_order: 44 --- -> [!WARNING] +{: .warning } > Unless you have a strong need for these plugins, using them is not recommended. If > you do use them, at least don't enable them for all feeds. diff --git a/docs/Generated-Feeds.md b/docs/Generated-Feeds.md index 5a529b9..8e19975 100644 --- a/docs/Generated-Feeds.md +++ b/docs/Generated-Feeds.md @@ -10,7 +10,7 @@ this icon: ![Generated feed icon](../images/gen_feed_icon.png) -> [!WARNING] +{: .warning } > Subscribing to your own feed of search results is going to produce > duplicate articles on each and every feed update. diff --git a/docs/Global-Config.md b/docs/Global-Config.md index bd9df06..204cb7f 100644 --- a/docs/Global-Config.md +++ b/docs/Global-Config.md @@ -52,7 +52,7 @@ putenv('TTRSS_SESSION_COOKIE_LIFETIME=86400*30'); // instead you're casting string literal "86400*30" to an integer ``` -> [!NOTE] +{: .note } > All values should be precalculated when setting via `.env` because they are not evaluated by PHP and used as-is. ## Minimal config.php for a non-Docker setup diff --git a/docs/Installation-Guide.md b/docs/Installation-Guide.md index 7ffd78e..88b4792 100644 --- a/docs/Installation-Guide.md +++ b/docs/Installation-Guide.md @@ -22,7 +22,7 @@ Docker images for are being built (for `linux * GitHub Container Registry (as-[ghcr.io/tt-rss/tt-rss](https://github.com/orgs/tt-rss/packages/container/package/tt-rss) and [ghcr.io/tt-rss/tt-rss-web-nginx](https://github.com/orgs/tt-rss/packages/container/package/tt-rss-web-nginx)). -> [!WARNING] +{: .warning } > Podman is not Docker. Please don't report issues related to running tt-rss when using Podman or Podman Compose. This setup uses PostgreSQL and runs tt-rss using several containers as outlined below. @@ -89,7 +89,7 @@ HTTP_PORT=127.0.0.1:8280 >[!WARNING] > See [this FAQ entry](#i-got-the-updated-docker-compose-file-above-and-now-my-database-keeps-restarting) > if you're upgrading between PostgreSQL major versions (e.g. 15 to-17). -> [!WARNING] +{: .warning } > Regarding PostgreSQL 18: > * The `backups` container image currently includes `postgresql17-client`, meaning it won't be able to back up your DB if you use PostgreSQL 18. Consider using an alternative backup solution if you're using PostgreSQL 18. @@ -207,7 +207,7 @@ services: `BUILDKIT_CONTEXT_KEEP_GIT_DIR` build argument is needed to display tt-rss version info properly. If that doesn't work for you (no-BuildKit?) you'll have to resort to terrible hacks. -> [!WARNING] +{: .warning } > Self-built images are not necessarily supported (i.e. best effort and/or community-support). ### I got the updated Docker Compose file above and now my database keeps restarting @@ -303,7 +303,7 @@ Note: `sudo -E` is needed to keep environment variables. ### How do I add plugins and themes? -> [!NOTE] +{: .note } > First party plugins can be added using plugin installer in `Preferences` → `Plugins`. By default, tt-rss code is stored on a persistent Docker volume (`app`). You can find diff --git a/docs/Plugins.md b/docs/Plugins.md index ef6b5d9..745597c 100644 --- a/docs/Plugins.md +++ b/docs/Plugins.md @@ -27,7 +27,7 @@ If you are interested in making plugins, see [Making-Plugins](Making-Plugins), ### Installing plugins -> [!NOTE] +{: .note } > First party plugins can be added via built-in plugin installer in `Preferences` → `Plugins`. Copy plugin folder to ```tt-rss/plugins.local``` then activate it in the settings panel. @@ -40,10 +40,10 @@ i.e. ``Af_ExamplePlugin`` should be copied to ``plugins.local/af_exampleplugin`` ## Third party plugins -> [!WARNING] +{: .warning } > We're not responsible for third party plugins. Use at your own risk. > -> [!NOTE] +{: .note } > Third party plugins may be unmaintained and incompatible with newer tt-rss > code (especially those from the old-forums). Please report plugin-related > problems to their developers. diff --git a/docs/Publish-Articles.md b/docs/Publish-Articles.md index 017edc5..0aa67cc 100644 --- a/docs/Publish-Articles.md +++ b/docs/Publish-Articles.md @@ -17,5 +17,5 @@ icon](http://feedicons.com/) near headline title: Resulting URL is displayed in Preferences (`Feeds` → `Published & shared-articles`). -> [!NOTE] +{: .note } > You can also publish articles automatically using filters (`Action` → `Publish-article`). diff --git a/docs/SSL-Certificate-Authentication.md b/docs/SSL-Certificate-Authentication.md index 29d742c..479b135 100644 --- a/docs/SSL-Certificate-Authentication.md +++ b/docs/SSL-Certificate-Authentication.md @@ -4,7 +4,7 @@ title: SSL Certificate Authentication nav_order: 52 --- -> [!WARNING] +{: .warning } > This guide is considered legacy and is no longer supported as it is not compatible with the > [stock Docker Compose](Installation-Guide) setup. Please don't report any issues when > trying to DIY this. diff --git a/docs/Search-Syntax.md b/docs/Search-Syntax.md index 52a876f..50ac096 100644 --- a/docs/Search-Syntax.md +++ b/docs/Search-Syntax.md @@ -4,7 +4,7 @@ title: Search Syntax nav_order: 48 --- -> [!NOTE] +{: .note } > This only applies to built-in search, other search plugins like may override this syntax. Search query consists of several keywords. Keyword starting with "-" is considered a negative match. Several special keywords are available: diff --git a/docs/Securing-Cache-Directories.md b/docs/Securing-Cache-Directories.md index 0d773f8..8b5a4a5 100644 --- a/docs/Securing-Cache-Directories.md +++ b/docs/Securing-Cache-Directories.md @@ -4,7 +4,7 @@ title: Securing Cache Directories nav_order: 49 --- -> [!NOTE] +{: .note } > Official container images restrict `/cache` access by default. This page applies only to > legacy host installations. diff --git a/docs/Sorting.md b/docs/Sorting.md index 2129420..97be200 100644 --- a/docs/Sorting.md +++ b/docs/Sorting.md @@ -7,7 +7,7 @@ nav_order: 51 Tiny Tiny RSS provides four options for how articles appear within a selected feed: `Default`, `Newest`, `Oldest`, `Title`. -> [!NOTE] +{: .note } > Special feeds (e.g. *Starred-articles*) have unique sorting when *Default* is selected, otherwise they behave as described below. - *Descending score* means **higher numbers** are shown before lower numbers. diff --git a/index.md b/index.md index c3673fe..9022372 100644 --- a/index.md +++ b/index.md @@ -44,10 +44,10 @@ You will need the following: See the [Installation Guide](docs/Installation-Guide.md) for detailed instructions. -> [!WARNING] +{: .warning } > If you choose to run tt-rss without using Docker support might be limited. > -> [!NOTE] +{: .note } > Tiny Tiny RSS uses a continuous development model based on the `main` branch, which is considered stable. > It's strongly recommended that you remain current-- meaning using either the most recent Docker image(s) or commit on `main`.