Files
FreshRSS/docs/_config.yml
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

54 lines
1.1 KiB
YAML

title: FreshRSS
description: Documentation center
baseurl: /FreshRSS
logo: /img/FreshRSS-logo.png
include: [contributing.md]
exclude: [CHANGELOG*.md, README.md, vendor]
defaults:
-
scope:
path: "/en/*"
values:
lang: "en"
-
scope:
path: "/fr/*"
values:
lang: "fr"
translations:
en:
back_to_freshrss: Back to freshrss.org
search_docs: Search docs…
search: Search
toggle_aside: Toggle sidebar
close: Close
choose_language: Choose language
copy_to_clipboard: Copy to clipboard
fr:
back_to_freshrss: Retour à freshrss.org
search_docs: Rechercher dans la documentation…
search: Rechercher
toggle_aside: Afficher/masquer le panneau
close: Fermer
choose_language: Choisir la langue
copy_to_clipboard: Copier dans le presse-papiers
plugins:
# gh
- jekyll-coffeescript
- jekyll-commonmark-ghpages
- jekyll-gist
- jekyll-github-metadata
- jekyll-paginate
- jekyll-relative-links
- jekyll-optional-front-matter
- jekyll-readme-index
- jekyll-default-layout
- jekyll-titles-from-headings
# custom
- jekyll-i18n_tags