diff options
| author | 2025-06-01 22:50:58 +0200 | |
|---|---|---|
| committer | 2025-06-01 22:50:58 +0200 | |
| commit | 7d86cbe804f873895ea2c6ee76f652661f42341e (patch) | |
| tree | 73ed7a06b8c46c84867b578b47027da0725770dd /docs/en | |
| parent | ec7edacf8cc537e9d5eea334e8112267d9aa1a4e (diff) | |
Bump markdownlint-cli from 0.44.0 to 0.45.0 (#7632)
* Bump markdownlint-cli from 0.44.0 to 0.45.0
Bumps [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) from 0.44.0 to 0.45.0.
- [Release notes](https://github.com/igorshubovych/markdownlint-cli/releases)
- [Commits](https://github.com/igorshubovych/markdownlint-cli/compare/v0.44.0...v0.45.0)
---
updated-dependencies:
- dependency-name: markdownlint-cli
dependency-version: 0.45.0
dependency-type: direct:development
update-type: version-update:semver-minor
...
Signed-off-by: dependabot[bot] <support@github.com>
* Fix Markdown
---------
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
Diffstat (limited to 'docs/en')
| -rw-r--r-- | docs/en/admins/16_OpenID-Connect.md | 6 | ||||
| -rw-r--r-- | docs/en/admins/Caddy.md | 10 | ||||
| -rw-r--r-- | docs/en/contributing.md | 2 | ||||
| -rw-r--r-- | docs/en/developers/01_Index.md | 2 | ||||
| -rw-r--r-- | docs/en/developers/02_GitHub.md | 2 | ||||
| -rw-r--r-- | docs/en/developers/03_Running_tests.md | 4 | ||||
| -rw-r--r-- | docs/en/developers/06_Reporting_Bugs.md | 4 | ||||
| -rw-r--r-- | docs/en/users/04_Subscriptions.md | 2 | ||||
| -rw-r--r-- | docs/en/users/05_Configuration.md | 66 |
9 files changed, 50 insertions, 48 deletions
diff --git a/docs/en/admins/16_OpenID-Connect.md b/docs/en/admins/16_OpenID-Connect.md index bab24f66b..373bcd231 100644 --- a/docs/en/admins/16_OpenID-Connect.md +++ b/docs/en/admins/16_OpenID-Connect.md @@ -57,6 +57,6 @@ See our reference [Apache configuration](https://github.com/FreshRSS/FreshRSS/bl See specific instructions for: -* Authentik: [here](16_OpenID-Connect-Authentik.md) or [here](https://goauthentik.io/integrations/services/freshrss/) -* Authelia: [here](https://www.authelia.com/integration/openid-connect/freshrss/) -* Pocket ID: [here](18_Pocket-ID.md) +* Authentik: [here (freshrss.org)](16_OpenID-Connect-Authentik.md) or [here (goauthentik.io)](https://goauthentik.io/integrations/services/freshrss/) +* Authelia: [here (authelia.com)](https://www.authelia.com/integration/openid-connect/freshrss/) +* Pocket ID: [here (freshrss.org)](18_Pocket-ID.md) diff --git a/docs/en/admins/Caddy.md b/docs/en/admins/Caddy.md index 39af5ddb4..7b7a73610 100644 --- a/docs/en/admins/Caddy.md +++ b/docs/en/admins/Caddy.md @@ -39,13 +39,13 @@ To set up FreshRSS behind a reverse proxy with Caddy and using a subfolder, foll Restart Caddy to apply the configuration changes: - ```bash + ```sh docker compose restart caddy ``` Restart FreshRSS to ensure that it recognizes the new base URL: - ```bash + ```sh docker compose restart freshrss ``` @@ -69,7 +69,7 @@ To set up FreshRSS behind a reverse proxy with Caddy and using a subdomain, foll Replace `example.com` with your actual domain and `subdomain` with the subfolder where you want FreshRSS to be hosted. - > **_NOTE:_** Ensure that the Docker container name for FreshRSS (freshrss in this example) matches the name used in the Caddyfile configuration. + > **_NOTE:_** Ensure that the Docker container name for FreshRSS (freshrss in this example) matches the name used in the Caddyfile configuration. > **_NOTE:_** Make sure to set the DNS Records for your configured subdomain. 2. **Update FreshRSS Configuration:** @@ -86,13 +86,13 @@ To set up FreshRSS behind a reverse proxy with Caddy and using a subdomain, foll Restart Caddy to apply the configuration changes: - ```bash + ```sh docker compose restart caddy ``` Restart FreshRSS to ensure that it recognizes the new base URL: - ```bash + ```sh docker compose restart freshrss ``` diff --git a/docs/en/contributing.md b/docs/en/contributing.md index 3e62f75c5..a92522644 100644 --- a/docs/en/contributing.md +++ b/docs/en/contributing.md @@ -54,7 +54,7 @@ If you want to give some help, meet us in the main repositories [docs directory] FreshRSS offers some official themes. If you have a good sense for great UI you are invited to share your theme with the community (via a [show&tell discussion thread](https://github.com/FreshRSS/FreshRSS/discussions/categories/show-and-tell) or as a [Pull Request](https://github.com/FreshRSS/FreshRSS/pulls)). -Basic Information for creating a new theme are written [here](./developers/04_Frontend/02_Design.md). +Check the [basic information for creating a new theme](./developers/04_Frontend/02_Design.md). This checklist is designed to ensure high-quality system themes while minimizing maintenance efforts. diff --git a/docs/en/developers/01_Index.md b/docs/en/developers/01_Index.md index 0e59b8c12..50ba84285 100644 --- a/docs/en/developers/01_Index.md +++ b/docs/en/developers/01_Index.md @@ -31,4 +31,4 @@ Start by creating your development environment. A guide to setting up FreshRSS†## Minz -Minz is the homemade PHP framework used by FreshRSS. More information can be found [here](Minz/index.md). +Minz is the homemade PHP framework used by FreshRSS. See the [dedicated documentation](Minz/index.md). diff --git a/docs/en/developers/02_GitHub.md b/docs/en/developers/02_GitHub.md index 066d6ffb0..51324349e 100644 --- a/docs/en/developers/02_GitHub.md +++ b/docs/en/developers/02_GitHub.md @@ -59,4 +59,4 @@ A commit message should succinctly describe the changes on the first line. For e If necessary, this can be followed by a blank line and a longer explanation. -For further tips, see [here](https://chris.beams.io/posts/git-commit/). +For further tips, see [here (chris.beams.io)](https://chris.beams.io/posts/git-commit/). diff --git a/docs/en/developers/03_Running_tests.md b/docs/en/developers/03_Running_tests.md index dabff8477..c5f962a6d 100644 --- a/docs/en/developers/03_Running_tests.md +++ b/docs/en/developers/03_Running_tests.md @@ -42,7 +42,7 @@ If you are interested, you can take a look at [the configuration file](https://g ## Using feed snapshots As feed data is volatile, it’s better to work with snapshots when debugging some issues. -You can find the description to retrieve a snapshot [here](06_Reporting_Bugs.md#how-to-provide-feed-data). +Check the [description to retrieve a snapshot](06_Reporting_Bugs.md#how-to-provide-feed-data). To serve those snapshots, you can use a mock server. Here we will demonstrate how to work with [WireMock](https://wiremock.org/) but other solutions exist. @@ -70,7 +70,7 @@ If you do not have one, you need to create one. } ``` 1. Launch the containerized server with the following command: - ```bash + ```sh # <PORT> is the port used on the host to communicate with the server # <NETWORK> is the name of the docker network used (by default, it’s freshrss-network) docker run -it --rm -p <PORT>:8080 --name wiremock --network <NETWORK> -v $PWD:/home/wiremock wiremock/wiremock:latest-alpine --local-response-templating diff --git a/docs/en/developers/06_Reporting_Bugs.md b/docs/en/developers/06_Reporting_Bugs.md index 0c5d255ff..0707fcba3 100644 --- a/docs/en/developers/06_Reporting_Bugs.md +++ b/docs/en/developers/06_Reporting_Bugs.md @@ -37,7 +37,7 @@ Here are some tips to help you present your bug report or suggestion: * Not all bugs require logs, but if you have any doubts, it is better to provide them to us. Logs are important and very useful for debugging! * The logs may reveal confidential information, so **be careful not to disclose anything sensitive.** * If you report a feed problem, it will be easier if you could provide a snapshot of its content in a text file. -See [here](#how-to-provide-feed-data) for more information. +See [further down](#how-to-provide-feed-data) for more information. In addition, when facing a bug, you’re encouraged to follow this message format (from the [Sam & Max website](http://sametmax.com/template-de-demande-daide-en-informatique/): @@ -72,7 +72,7 @@ Remember to give the following information if you know it: If you need us to investigate a feed problem, it will be easier if you provide a snapshot of the feed data. To do that, you can launch the following command: -```bash +```sh wget <feed url> -O output.rss.txt ``` Then you can drag-and-drop the generated file into the issue. diff --git a/docs/en/users/04_Subscriptions.md b/docs/en/users/04_Subscriptions.md index f865a836f..4161c188e 100644 --- a/docs/en/users/04_Subscriptions.md +++ b/docs/en/users/04_Subscriptions.md @@ -43,7 +43,7 @@ This question comes up regularly, so we’ll try to clarify how one can retrieve Please be aware that this way you’ll generate much more traffic to the originating sites, and they might block you accordingly. FreshRSS performance is also negatively affected, because you’ll have to fetch the full article content one by one. So it’s a feature to use sparingly! -The "Article CSS selector on original website" corresponds to the "path" consisting of IDs and classes (which in HTML, matches the id and class attributes) to retrieve only the interesting part that corresponds to the article. Ideally, this path starts with an id (which is unique to the page). The basics are explained [here](https://developer.mozilla.org/en-US/docs/Learn/CSS/Building_blocks/Selectors). +The "Article CSS selector on original website" corresponds to the "path" consisting of IDs and classes (which in HTML, matches the id and class attributes) to retrieve only the interesting part that corresponds to the article. Ideally, this path starts with an id (which is unique to the page). The basics are explained [here (MDN)](https://developer.mozilla.org/en-US/docs/Learn/CSS/Building_blocks/Selectors). ##### Example: Rue89 diff --git a/docs/en/users/05_Configuration.md b/docs/en/users/05_Configuration.md index a92d0f5db..499e770d0 100644 --- a/docs/en/users/05_Configuration.md +++ b/docs/en/users/05_Configuration.md @@ -1,7 +1,9 @@ -# Display +# Configuration -## Language +## Display + +### Language FreshRSS is currently available in 22 languages. After confirming your choice, the interface will be displayed in your preferred language. Depending on the language chosen, parts of the interface may not be not translated yet. If you’re willing to help translate @@ -37,7 +39,7 @@ Available languages are: | Chinese (Simplified, People’s Republic of China) | 简体ä¸ć–‡ | zh-cn | | Chinese (Traditional, Taiwan) | ćŁé«”ä¸ć–‡ | zh-tw | -## Theme +### Theme There’s no accounting for tastes, which is why FreshRSS offers 13 official themes: @@ -61,7 +63,7 @@ To select a theme, simply scroll through the themes and select one that strikes If you can’t find any themes you like, it’s always possible to [create your own](../developers/04_Frontend/02_Design.md) and [install it](../admins/11_Themes.md). For small theme changes, the official [CustomCSS extension](https://github.com/FreshRSS/Extensions) is recommended. -## Content width +### Content width Some people prefer short lines of text, while others prefer to maximize the available screen space. To satisfy the maximum number of people, it’s possible to customize the width of the displayed content. There are four settings available: @@ -70,7 +72,7 @@ Some people prefer short lines of text, while others prefer to maximize the avai * **Large** displays content up to a maximum width of 1000 pixels * **No limit** displays the content on 100% of the available space -## Article icons +### Article icons Please note that this section only affects normal view. @@ -83,13 +85,13 @@ If you disable every item in the top line, you’ll still be able to see it sinc it contains the feed name and the article title. But if you do the same thing for the bottom line, it will be empty. -## HTML5 notification timeout +### HTML5 notification timeout After automatically updating the feeds, FreshRSS can pop up a notification using the HTML5 notification API. The duration of this notification can be set. By default, the value is 0. -## Show the navigation button +### Show the navigation button By default, FreshRSS displays buttons to ease the article navigation when browsing on mobile. The drawback is that they eat up some precious space. @@ -97,31 +99,31 @@ By default, FreshRSS displays buttons to ease the article navigation when browsi If you don’t use those buttons because you never browse on mobile or because you browse with gestures, you can disable them from the interface. -# Reading +## Reading -## Number of articles per page +### Number of articles per page This setting defines the number of articles to display at once before needing to load more. In normal and reading view, more articles are loaded automatically. In global view, a button will appear at the bottom of the list. -## Articles to display +### Articles to display The status of articles to display when loading FreshRSS. "Adjust showing" will display only unread articles by default, but will display all articles when there are no unread articles to show. -## Use “lazy load” mode to load images +### Use “lazy load” mode to load images This will set images to load as they are viewed. This can save data, but will can cause images to load in later. -# Archival +## Archival -## Archiving +### Archiving These are the global options for fetching and retaining articles from feeds. They can be overridden by individual feed’s settings. -## Maintenance +### Maintenance This allows for purging/optimizing the current user’s articles in the database. -# Sharing +## Sharing To make your life easier, you can share articles straight from FreshRSS. @@ -133,17 +135,17 @@ By default, the sharing list is empty. To add a new item to the list, please follow the following simple steps: 1. Select the desired sharing method in the drop-down list. -1. Press the ```âśš``` button to add it to the list. -1. Configure the method in the list. All names can be modified in the display. Some methods need the sharing URL to be able to work properly (ex: Shaarli). -1. Submit your changes. +2. Press the ```âśš``` button to add it to the list. +3. Configure the method in the list. All names can be modified in the display. Some methods need the sharing URL to be able to work properly (ex: Shaarli). +4. Submit your changes. To remove an item from the list, follow those simple steps: 1. Press the ```❌``` button next to the share method you want to remove. -1. Submit your changes. +2. Submit your changes. -# Shortcuts +## Shortcuts To ease the use of the application, FreshRSS comes with a lot of predefined keyboard shortcuts. They allow actions to improve the user experience with a keyboard. @@ -153,9 +155,9 @@ Of course, if you’re not satisfied with the key mapping, you can change you co There are 4 types of shortcuts: 1. Views: they allow switching views with ease. -1. Navigation: they allow navigation through articles, feeds, and categories. -1. Article actions: they allow interactions with an article, like sharing or opening it on the original web-site. -1. Other actions: they allow other interactions with the application, like opening the user queries menu or accessing the documentation. +2. Navigation: they allow navigation through articles, feeds, and categories. +3. Article actions: they allow interactions with an article, like sharing or opening it on the original web-site. +4. Other actions: they allow other interactions with the application, like opening the user queries menu or accessing the documentation. It’s worth noting that the share article action has two levels. Once you press the shortcut, a menu containing all the share options opens. To choose one share option, you need to select it by its number. When there is only one option, it’s selected automatically though. @@ -165,25 +167,25 @@ The same process applies to the user queries. Be aware that there is no validation on the selected shortcuts. This means that if you assign a shortcut to more than one action, you’ll end up with some unexpected behavior. -# User queries +## User queries You can configure your [user queries](./user_queries.md) in that section. -# Profile +## Profile You can change your email address or password here. The authentication token is required for accessing the aggregated RSS feed for a user. A blank token will disable accessing the RSS feed without being logged in. -# Extensions +## Extensions Extensions can be managed from this menu. Note that while extensions can be removed from the web interface, they cannot be added from it. Some extensions have configurations and these can be changed in the manage page, which opens with the button near the name of the extension. -## User CSS +### User CSS It gives ability to create user-specific CSS rules to apply in addition of the actual theme. -### Example: Getting rid of Top Menu Items +#### Example: Getting rid of Top Menu Items The Top Menu within the mobile view might look a little bit cluttered, depending on the theme. The following CSS rules allow to hide unnecessary top menu buttons or input boxes. @@ -212,17 +214,17 @@ The Top Menu within the mobile view might look a little bit cluttered, depending } ``` -## User JS +### User JS It gives ability to create user-specific JS. -# Users +## Users > **TODO** -## Authentication methods +### Authentication methods -### HTTP Authentication (Apache) +#### HTTP Authentication (Apache) 1. User control is based on the `.htaccess` file. 2. It is best practice to place the `.htaccess` file in the `./i/` subdirectory so the API and other third party services can work. |
