Commit Graph

14 Commits

Author SHA1 Message Date
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
maTh
666e951fa3 docs: add deep links (#5493)
* add deep links

* Update docs/en/index.md

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

---------

Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2023-06-25 00:17:02 +02:00
maTh
eabe95e28c Docs: information about extensions (#4281)
* first draft

* Update docs/en/admins/15_extensions.md

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

* Update docs/en/admins/15_extensions.md

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

* Update docs/en/admins/15_extensions.md

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

* Update docs/en/admins/15_extensions.md

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

* Update 15_extensions.md

* Update docs/en/admins/15_extensions.md

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

* Update docs/en/admins/15_extensions.md

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

* Update docs/en/admins/15_extensions.md

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

* Update 15_extensions.md

* Update 15_extensions.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>
2022-03-22 22:59:53 +01:00
maTh
be5848fd4f Improved: Sharing/Integration configuration (#4269)
* stick plus button to select list

* HTML improved very much

* drag and drop improved

* add URL button

* fix remove button behavior

* prepare for PR#4238

* improve length of inputs

* First draft of documentation of the sharing services

* new config option: depricated

* i18n for depricated text

* Doc: Blogotext depricated to 2023

* dropdown menu with config link and depricated sign

* Update entry_bottom.phtml

* Update 08_sharing_services.md

* Update template.rtl.css

* Typo Deprecated/Depricated

* typo

* updated the documentation comment

* Update shares.php

* Update app/i18n/fr/conf.php

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

* Update p/scripts/draggable.js

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

* Update p/scripts/draggable.js

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

* Documentation: services from #4270

Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2022-03-15 22:58:30 +01:00
maTh
ed8703e674 Improved: Manual: username+pw for demo login (#4072)
* added: username+pw for demo login

* fix white spaces
2021-12-20 20:48:01 +01: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
maTh
051cf5be10 docs (#3784) 2021-08-20 14:06:00 +02: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
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
Alexandre Alapetite
bf838e74f4 French readme parity English (#2183)
https://github.com/FreshRSS/FreshRSS/pull/2158#issuecomment-444217219
2018-12-16 14:33:59 +01:00
Frans de Jonge
469d601bcb [doc] Editing for better style (#1736)
* Also removed references to Persona authentication.
* Changed code comment about Persona because it's for HTTP auth
  in general. See 3d876091e1
  and https://github.com/FreshRSS/FreshRSS/issues/358#issuecomment-31931484
2017-12-22 12:02:06 +01:00
Kevin Papst
b562639155 Documentation updates (#1697)
* added documentation about updating FreshRSS
moved Installation to admin directory
linked some already existing documentation files
2017-12-02 13:43:28 +01:00
Marien Fressinaud
6f2c0123be Change main page of english documentation 2017-04-24 23:08:43 +02:00
Marien Fressinaud
afc38e43ec Provide documentation under ./docs 2017-04-24 23:08:43 +02:00