Commit Graph

70 Commits

Author SHA1 Message Date
Alexandre Alapetite
7c74653cc2 Update markdownlint-cli dev dependency (#4241)
* Update markdownlint-cli dev dependency
And fix https://github.com/advisories/GHSA-6vfc-qv3f-vr6c

* npm ci
2022-02-28 20:50:39 +01:00
maTh
639f8eea84 Documentation improved: mobile access (#4235)
* Update 06_Mobile_access.md

* Readme: Windows + MacOS

* fix markdown

* Update docs/en/users/06_Mobile_access.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* Update docs/en/users/06_Mobile_access.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* MacOS -> macOS

* Update 06_Mobile_access.md

* Update docs/en/users/06_Mobile_access.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>
2022-02-27 21:50:28 +01:00
xnaas
7ab4f89f54 Fixup #3991 (#3992)
* fixup #3991

* add xnaas to CREDITS.md

* Update docs/en/users/03_Main_view.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* fix typo

* Update docs/en/users/03_Main_view.md

The lines were combined into one line and `'` was replaced with `’` for contracted words.

Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>

Co-authored-by: maTh <math-home@web.de>
Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>
Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2022-01-21 16:41:17 +01:00
Alexandre Alapetite
1acd3ab09b Use typographic quotes (#4133)
* Use typographic quotes

* A few fixes

* Fix

* Fix not saved

* Implement feedback

* Detail

* Revert spoken English fixes
Left for a future dedicated discussion

* More reverts

* Final reverts

* Final minor
2022-01-08 21:58:55 +01:00
Thomas Renes
916df412f5 Fix various typos and spelling errors in documentation, comments and code. (#4134) 2022-01-08 16:25:17 +01:00
Alexandre Alapetite
fb15a2d804 Search on article IDs (#4058)
* Search on article IDs
Partial implementation of https://github.com/FreshRSS/FreshRSS/issues/4053
2021-12-31 13:10:41 +01:00
happymacarts
f0ca1288d2 Update 02_First_steps.md (#4049)
spelling correction of "available"
2021-12-10 11:48:50 +01:00
xnaas
1595d557b0 Fix typo of 'envelope' and reference De Morgan's laws (#3991) 2021-11-24 09:05:18 +01:00
Alexandre Alapetite
88e47dba80 Hot fix broken links documentation
Bug from https://github.com/FreshRSS/FreshRSS/pull/3905
2021-10-24 18:23:50 +02:00
Alexandre Alapetite
acbba9adb2 Improved markdownlint (#3918)
* Improved markdownlint
* Relaxed rules slighlty
* `npm run markdownlint` for automatic tests
* `npm run markdownlint_fix` for automatic syntax fixing
* Applied the fixes on all our Markdown files
2021-10-23 13:43:24 +02:00
Felix Bühler
915dcc3ccc Split fever & greader into two separate pages. (#3905)
* [docs] add newsflash to fever-clients

* [docs] split fever&greader-apis into two pages and make the more consistent
2021-10-23 13:32:20 +02:00
OctopusET
1f8fd53c3f Update Korean Translation with language code fix (#3914)
* Update Korean Translation

* Fix Korean language code following IETF BCP 47

* Fix Korean language code in i18n/*/gen.php

* Fix Korean language code in cli/i18n/*

* Fix Korean language code in docs

Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2021-10-23 12:14:16 +02:00
Alexandre Alapetite
705be9a6a1 Search labels (#3709)
* Search labels
#fix https://github.com/FreshRSS/FreshRSS/issues/3704

* Documentation

* Allow list without quotes

* Allow boolean AND searches

* Allow searching any label

* fix labels alias
2021-07-24 19:32:43 +02:00
Petra Lamborn
90ea2156f6 Newsboat support (#3574)
* Newsboat support

Newsboat is a feed reader for the unix-derived terminal, and is the successor to Newsbeuter. FreshRSS support has been merged into master <f18145fc98> but there has not yet been a release since then. In the meantime I've created this pull request that can be merged whenever it becomes strictly accurate.

I've filled out the table to the best of my ability, but I'm not completely clear on what "Fast sync" and "Fetch more in individual views" mean.

* Does not work offline with freshrss

* More doc

Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2021-04-08 18:32:27 +02:00
Alexandre Alapetite
1c3159058f Quick update the doc for master renaming to edge 2021-03-15 00:00:25 +01:00
Alexandre Alapetite
b455b29c8c FocusReader (#3514) 2021-03-10 20:28:58 +01:00
ldv8434
bf344cd302 Update and add to documentation (#3348)
* remove outdated mailing list information

* add information about normal view

* add information about global and reader view

* fix import section header

* reorder documentation to reflect menu's order

* clarify setting as default in normal view

* add info about reading section for config

* fix heading levels, add info about archive + profile sections

* unfix heading levels

* move section on feed-specific settings to the subscription management page

* update information about adding feeds, add information about feed management

* fix link to security page in installation

* fix broken links

* fix broken link to install page

* add lighttpd from project readme

* add php modules to step 4, add horizontal line to better separate steps from footnotes visually

* fix broken link

* add index page for easier access of other pages

* move first steps document

* make dedicated bug reporting page

* make index page for linking to other pages

* moved fever API to relevant location, linked to index

* remove outdated mailing list information

* add information about normal view

* add information about global and reader view

* fix import section header

* reorder documentation to reflect menu's order

* clarify setting as default in normal view

* add info about reading section for config

* fix heading levels, add info about archive + profile sections

* unfix heading levels

* move section on feed-specific settings to the subscription management page

* update information about adding feeds, add information about feed management

* fix link to security page in installation

* fix broken links

* fix broken link to install page

* add lighttpd from project readme

* add php modules to step 4, add horizontal line to better separate steps from footnotes visually

* fix broken link

* add index page for easier access of other pages

* move first steps document

* make dedicated bug reporting page

* make index page for linking to other pages

* moved fever API to relevant location, linked to index

* re-fix link

* remove mention of defunct mailing list

* grammar fix

* replace stream with feed

* add optional items, replace stream with feed

* replace stream with feed

* fix word choice

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* fix word choice

better reflect age of project

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* grammar fixes

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* remove double headings

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* change single quote to double quote for consistency

* add subreddit link

* change php module list to Dockerfile link

* fix link to developer index, change html links to md for consistency

* update css selector terms

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>
2021-01-10 20:50:54 +01:00
Alexis Degrugillier
85cbfcedb5 Update user query feature (#3338)
* Change user query wording

There was some misunderstanding in the use of the user query feature,
probably because of the wording. I've change it to make it more obvious.

* Fix feedback when a query is bookmarked

Before, the displayed query name was not the one intended. Now, the name is the one of the current bookmark

* Document user queries

I've added a few words on how to use the user queries because it seems there was some misunderstanding. See #3219
2021-01-07 21:47:39 +01:00
rom-1
aa3e41d4b3 Adding info about combining css classes (#3329)
* Adding info about combining css classes 

Adding info about combining css classes using comma separation

* Update 05_Configuration.md

* Apply suggestions from code review

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>
2021-01-03 20:37:57 +01:00
Alexis Degrugillier
082ef9854c Add section for text import (#3304)
See #663
2021-01-02 17:37:26 +01:00
rom-1
71c541db7f Update 03_Main_view.md (#3307)
adding to documentation: filtering a tag with whitespace
2020-12-31 14:50:13 +01:00
Alwaysin
fdf40c95b9 Update link to News+ Google Reader extension (#3252)
* Remove News+ (Google Reader extension does not exist anymore)

* Remove News+ (Google Reader extension does not exist anymore)

* Update link to News+ Google Reader extension

* Update link to News+ Google Reader extension

* A few more links

Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2020-11-12 11:52:52 +01:00
tonitonae
fdfe6e7038 Update FAQ with firewall issues. (#3225)
* Update FAQ with firewall issues.

* Update docs/en/users/07_Frequently_Asked_Questions.md

Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>

Co-authored-by: tonitonae <tonitonae@zetmail.com>
Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2020-10-15 10:27:43 +02:00
No Name Pro
162f31f82e Docs: Add Fluent Reader to API Clients (#3140)
* Docs: Add Fluent Reader to API Clients

Fluent Reader is a desktop RSS reader built with Electron, React, and Fluent UI supporting Fever API.

See more: https://github.com/yang991178/fluent-reader

* RSS client list: Add section for cross plattform

Adds in the RSS Client List a Section for Cross-Plattform Desktop Clients (Windows, Linux and MacOS)

* Docs: API Clients: Table instead of List

* Docs: API Clients: Change `Free Software` to `License`

* Add me (No Name Pro) to Credits-File :)

* Docs (FR): API Client List as table + Fluent Reader
2020-08-18 15:01:14 +02:00
saimyx
a76caf78e7 documentation utilisateur / user doc (#2948)
* Update 04_Subscriptions.md

- ajouter un flux
- import/export

* Update 04_Subscriptions.md

* Update 04_Subscriptions.md

* Update 04_Subscriptions.md

Translated in english from https://github.com/Saimyx/FreshRSS/edit/master/docs/fr/users/04_Subscriptions.md

* Update 04_Subscriptions.md

* Update docs/en/users/04_Subscriptions.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* Update docs/en/users/04_Subscriptions.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* Update docs/en/users/04_Subscriptions.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* Update docs/en/users/04_Subscriptions.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* Update docs/en/users/04_Subscriptions.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* Update docs/en/users/04_Subscriptions.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* Update docs/en/users/04_Subscriptions.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* Update docs/en/users/04_Subscriptions.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* Update docs/en/users/04_Subscriptions.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* Update docs/en/users/04_Subscriptions.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* Update docs/en/users/04_Subscriptions.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* Update docs/en/users/04_Subscriptions.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* Update docs/fr/users/04_Subscriptions.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* Update 04_Subscriptions.md

* Update docs/en/users/04_Subscriptions.md

* Update docs/en/users/04_Subscriptions.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* Update docs/en/users/04_Subscriptions.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* Update docs/en/users/04_Subscriptions.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* Update docs/en/users/04_Subscriptions.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* Language improvements

* Language improvements

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>
Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2020-05-08 16:04:22 +02:00
Alexandre Alapetite
ae70374b03 Filter by multiple feed IDs (#2892)
Add the possibility to filter by feed ID like `f:123 more-search`
or multiple feed IDs, like `f:123,234,345 more-search` or an exclusion
like `!f:456,789 more-search`
2020-04-17 10:57:35 +02:00
Alexandre Alapetite
61c8026ac9 Implement negation for searching by date intervals (#2869)
* Implement negation for searching by date intervals

#fix https://github.com/FreshRSS/FreshRSS/issues/2866
Allow searching for e.g. `!date:P1W` to exlude all articles newer than
one week.
More generally, allows exclusion on some date intervals.

* Fix OR
2020-04-01 17:26:19 +02:00
Alexandre Alapetite
4fa6e27397 Fix broken doc link (#2832)
#Fix https://github.com/FreshRSS/FreshRSS/issues/2824
2020-03-21 21:56:36 +01:00
Frans de Jonge
705318aa39 Translate docs with po4a (#2590)
* [i18n] Add docs po4a script

* Add proof of concept

* Add a few more translations

* Hush ShellCheck and shfmt

* Make that list po4a-friendly

* drat, this document could've probably been auto-generated

* Definitive proof that it's translated from French ;-)

* Add some brand spanking new French translation

* More translation

* Mostly finish that config page

* Fix up FAQ

* More contributing

* Dev first steps

* Let's ignore that admin stuff at the very least for now

* Translate release new version, make French the source first and copy all translations

Then replace French with English in the source.

Much quicker than any alternative route.

* And add the English translation

* Minor stylistic leftover from French

* Most of first steps

* Forgot the extensions

* Use po4a 0.56 to get rid of way too many newlines

* Fix up those newlines

* No point linking to Firefox integration anymore from the new user guide

* Start on main view

* A bunch of main view stuff

* More main view

* And some subscriptions before going to bed

* First steps for devs

* More dev first steps

* Incomplete French → English dev/GH translation

Because I need to ask about that mailing list thing

* Fix typo in docs/en/developers/02_Github.md

* Translate & complete devs/github to English

* Fix up most of extensions

* Is that supposed to be a non-breaking space? Let's see

* Match up some users/mobile access

* More users/mobile access

* Add fresh French translation to Fever API

* Fix typo

* Match frontend todo thingies

* Fix a typo

* Some extensions strings

* Remove Fx subscription service from the docs

Cf. https://github.com/FreshRSS/FreshRSS/pull/2606

* Add translation for https://github.com/FreshRSS/FreshRSS/pull/2643

* fix typo as per https://github.com/FreshRSS/FreshRSS/pull/2643#discussion_r345433009

* Add some more French translations

* Update French translation as per @aledeg comment https://github.com/FreshRSS/FreshRSS/pull/2590#discussion_r345465909

* Translate some of the meaningless stuff

* Translate the rest of contributing.md to French

* Fix conflicts

* Translate Docker first steps to French

* Update with change from #2665

* Add @aledeg corrections

* Overlooked a couple @aledeg corrections thanks to GitHub autohide

* Latest @aledeg suggestions
2019-12-03 22:37:40 +01:00
Ryan Nielson
b2c77d1cb4 Fix link to installation instructions on first steps (#2665) 2019-11-14 15:22:48 +01:00
rezad
8bdf7b09f2 Replace some http links with https links (#2662) 2019-11-13 20:52:52 +01:00
Alexis Degrugillier
59f284d229 Rename sharing action (#2643)
Before, some ad-blocker rules were preventing to display the sharing page
because of its name. I've renamed that page to integration but kept every
thing else identical. So it's still called sharing through out the
application.
If needed, this can be addressed as well.

See #2509 and #2419
2019-11-08 23:49:43 +01:00
Stoinov
6d330206af Reeder added native support (#2578)
* Reeder aded native support
Added Reeder as supported in Reader page
Clarified how to use the Fever API with Reeder
Fixed some typos on both pages
2019-10-19 12:03:06 +02:00
Alexandre Alapetite
37b52b7361 Trim whitespace (#2544) 2019-10-01 18:12:21 +02:00
Alexandre Alapetite
823f581523 Document Reeder compatibility (#2540)
https://github.com/FreshRSS/FreshRSS/issues/2513
https://github.com/FreshRSS/FreshRSS/pull/2526
2019-09-28 23:16:21 +02:00
Alexandre Alapetite
fd33d92d41 Require PHP 5.5+ (#2495)
* Require PHP 5.5+

https://github.com/FreshRSS/FreshRSS/issues/2469#issuecomment-522255093
I think it would be reasonable to require PHP 5.5+ for the core of
FreshRSS after all.

As Frenzie said, WordPress currently requires PHP 5.6.20+, and it is the
most popular PHP application.

We would loose about 20% of the PHP servers according to
https://w3techs.com/technologies/details/pl-php/5/all but I expect this
number to drop fast after the release of CentOS 8 (CentOS accounts for
17% of Linux servers
https://w3techs.com/technologies/details/os-linux/all/all ).

Distributions:
* no impact on Ubuntu, Fedora, Alpine, OpenWRT, FreeBSD, OpenSuze,
Mageia, as all active versions have PHP > 7
* no impact on OpenSuze, Synology, as all active versions have PHP > 5.5
* we drop Debian 8 Jessie (-2020) - we keep supporting Debian 9 Stretch
(2017-06) - current is Debian 10 Buster
* we drop Red Hat 7 (-2024) - we keep supporting RHEL 8 (2019-05)
* we drop CentOS 7 (-2024) - we will support CentOS 8 (to be released
soonish)

When dropping older versions, I can better like when it is for a good
reason, and there is actually one with PHP 5.5, namely generators
(yield) https://php.net/language.generators.overview which I consider
using.

* Version note for JSON.php

* hex2bin

* Update .travis.yml

Co-Authored-By: Frans de Jonge <fransdejonge@gmail.com>
2019-08-20 14:55:43 +02:00
Purexo
e09cf3fc71 Promote FreshRSS-Notify in user documentation (#2445)
* Add FreshRSS-Notify in Clients compatibles section

* Add FreshRSS-Notify in Compatible clients section

* Use language-neutral link

https://addons.mozilla.org/firefox/addon/freshrss-notify-webextension/
2019-07-15 15:44:50 +02:00
Alexandre Alapetite
b2d5ef4842 Merge pull request #2389 from Fake4d/patch-1
Update 03_Main_view.md
2019-05-30 12:34:10 +02:00
Alexandre Alapetite
5ccbd662c5 Fix typos 2019-05-30 12:33:27 +02:00
Alexandre Alapetite
05420ef40e Remove /de/ in URL 2019-05-30 12:30:35 +02:00
Fake4d
8df7caa0cf Update 06_Fever_API.md
Reeder-4 is new - Reeder-3 is the old version

BUT: 3 is free ;-)
And you have to pay for the new version.. So I dont know whether this should be linked here..
2019-04-29 11:03:01 +02:00
Fake4d
0cd992df37 Update 03_Main_view.md
Typo in Param maxFeeds
2019-04-29 10:40:54 +02:00
Fake4d
097d771869 Update 03_Main_view.md
Document all the parameters for "feed actualize".

the new parameter "maxfeeds" from Pull Request #2388 is already considered.
2019-04-29 10:35:28 +02:00
Alexandre Alapetite
b5e83abfc9 Add reference to Readably app
https://github.com/FreshRSS/FreshRSS/issues/1406#issuecomment-469310998
2019-03-09 12:50:03 +01:00
Alexandre Alapetite
a6623b7b2f Apache performance (#2202)
* Apache performance
API: Use SetEnvIf if available and fallback to RewriteRule
Docker: Disable unused modules.
Docker: Hard-include .htaccess to avoid having to scan for changes in
that file.
Docker: Disable security check of symlinks, which we do not use ayway.

* Apache readme

* Docker/Apache tuning
Run cron job with correct www-data user instead of root
Remove PHP GMP module uneeded for 64-bit Docker image
Add option to mount custom .htaccess for HTTP authentication
Re-add Apache module for HTTP authentication
Move Alpine-specific instructions to Docker file (instead of Apache
conf) to make it easier to have other base images than Alpine
2019-01-02 21:36:33 +01:00
Alexandre Alapetite
512d047f02 Update naming to WebSub (#2184)
Instead of PubSubHubbub / PuSH
2018-12-16 17:02:03 +01:00
Alwaysin
49869882e6 Documentation update (#2095)
* Add Phoronix CSS retrieve rule

* Update 05_Configuration.md

Mise à jour paragraphe des langues
Ajout règle CSS Phoronix

* Ajout outils externes pour récupérer contenu complet article

* Adding external tools to retrieve full-content

* Messed up for Phoronix, added back

* Update 05_Configuration.md

* Update 05_Configuration.md
2018-12-16 14:45:26 +01:00
Alexandre Alapetite
75a0b12c72 Documentation Vienna (#2126)
* Documentation Vienna / Open Reader

https://github.com/FreshRSS/FreshRSS/issues/2091
https://github.com/FreshRSS/FreshRSS/pull/2093
https://github.com/ViennaRSS/vienna-rss/issues/1197

* Remove references to Open Reader API for now
2018-12-16 14:43:32 +01:00
Frans de Jonge
e2cb8b929b [docs] Add note about specific user for webcron (#2142)
* [docs] Add note about specific user for webcron

Cf. https://github.com/FreshRSS/FreshRSS/issues/613#issuecomment-353585547

* Small changes

* Use one of the RFC addresses for examples
2018-11-18 21:08:41 +01:00
ryliejamesthomas
4dcddff532 Note stating manually adding custom subscription services removed in FF 63 (#2112)
* Note stating manually adding custom subscription services removed in FF 63

* Amended to mention bookmarklet and upcoming issues
2018-11-11 17:32:32 +01:00