mirror of https://github.com/FreshRSS/FreshRSS.git synced 2025-12-23 21:47:44 -05:00

Files

Inverle 5e9c3617ca Improve layout of documentation page and add search feature (#8247 )

* Improve layout of documentation page and add search feature

Closes https://github.com/FreshRSS/FreshRSS/issues/7915, https://github.com/FreshRSS/FreshRSS/issues/5325

Also: anchor headings and fix building site locally

* Further improvements

* Set color of hyperlinks
* Consistent styling of close aside button across devices
* Mobile layout 600px -> 1200px
* Add suffix to docs `<title>`
    * Note: titles of pages probably need to be improved, since currently they are just derived from the names of the first heading on every page
* Add favicon

* Improve font

* Try to fix favicon not loading correctly on GH pages

* Use local font

* Attempt to fix GH pages

* Final improvements

* Copy to clipboard button
* Support for nojs search
* Dark mode
* Load search.json (200KB json) only on search input focus
* Keep scroll state of sidebar across navigations

* Clickable images and CSP

CSP so we avoid hotlinking resources and clickable images are useful for zooming on mobile for example

* Fix typos

* Disable Dark Reader extension if dark mode CSS is loaded

* Support internationalisation (via language dropdown)

* Add Gemfile.lock

* Make CI build work with the custom plugin

* Make menus closable with Esc

* Fix typos CI

* Suggestions

* Use `ruby/setup-ruby` action in workflow for installing and caching gems.

* Run build only when there are changes to `docs/`

See: https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows?versionId=free-pro-team%40latest&productId=actions#running-your-workflow-only-when-a-push-to-specific-branches-occurs

* Change font to `Open Sans`

* Increase line height

* Fix Liquid syntax error

2025-12-04 20:06:21 +01:00

2.6 KiB

Raw Permalink Blame History

lang

lang
en

FreshRSS manual (English)

FreshRSS is an RSS aggregator and reader. It allows you to read and follow several news websites at a glance without the need to browse from one website to another.

Features

FreshRSS has a lot of features including:

RSS and Atom aggregation
Mark article as favorite if you liked it or if you want to read it later
Filter and search functionality helps to easily find articles (more information)
Statistics to show you the publishing frequency all the websites you follow
Import/export of your feeds into OPML format (more information)
Several themes created by the community (more information)
Several extensions created by the community (more information)
"Google Reader"-like API to connect Android applications (more information)
The application is "responsive," which means it adapts to small screens so you can bring articles in your pocket
Self-hosted: the code is free (under AGPL3 licence), so you can host your own instance of FreshRSS (more information)
Multi-user, so you can also host for your friends and family (more information)
share article links with a bunch of services (more information)
And a lot more!

Manual Chapters

This documentation is split into different sections:

User documentation, where you can discover all the possibilities offered by FreshRSS
Administrator documentation for detailed installation and maintenance related tasks
Developer documentation to guide you in the source code of FreshRSS and to help you if you want to contribute
Contributor guidelines for those who want to help improve FreshRSS

Demo

The official demo of FreshRSS is available under https://demo.freshrss.org/.

Username: demo
Password: demodemo

Another chance to try out, but not official supported by FreshRSS: The application is listed on Softaculous https://www.softaculous.com/apps/rss/FreshRSS.

Licence

FreshRSS is licensed under the GNU Affero General Public License v3.0.

2.6 KiB Raw Permalink Blame History