Files
FreshRSS/docs/_config.yml
polybjorn 4b96b01460 chore(docs): upgrade Jekyll 3 to 4 and Ruby to 3.4.9 (#8772)
Jekyll 3 is unmaintained and its safe_yaml dependency breaks on
Ruby 3.4+ where base64 left the default stdlib. The docs workflow
already runs `bundle exec jekyll build` directly, so GitHub Pages'
Jekyll 3 lock does not apply here.

Changes:

* Pin `jekyll ~> 4.3`. Replace `jekyll-commonmark-ghpages` (pinned
  to Jekyll 3) with upstream `jekyll-commonmark`. Drop unused
  `jekyll-paginate`. Add `gem 'base64'` so the lockfile stays valid
  on Ruby 3.4+ where it became a bundled gem.
* Move CommonMark options into `_config.yml` to match what the
  `-ghpages` variant enabled by default: SMART, FOOTNOTES, UNSAFE
  (so inline HTML like `<br>` in tables still renders), plus the
  strikethrough, autolink, table, and tagfilter extensions. Set
  Rouge as the highlighter.
* Strip the leading slash from `defaults.scope.path` (`/en/*` to
  `en`). Jekyll 4 requires no leading slash, otherwise `page.lang`
  silently fails to propagate and `jekyll-i18n_tags` crashes the
  build.
* Pass `generateId=true` to the existing `anchor_headings.html`
  include so headings get slugified IDs. The `-ghpages` variant
  produced these by default.
* Bump CI Ruby to 3.4.9 and `cache-version` to invalidate the old
  Jekyll 3 gem cache on the first run.

Build is about 9x faster (1.0s vs 9.2s). Compared the rendered
output page by page against the Jekyll 3 baseline; remaining
differences are whitespace, footnote class names (no CSS depends
on either set), and one HTML entity (`&#8617;`) becoming the
literal `↩`. Visually and functionally the same.

Co-authored-by: Bjørn A. Andersen <polybjorn@users.noreply.github.com>
2026-05-03 14:17:55 +02:00

59 lines
1.2 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
markdown: CommonMark
commonmark:
options: ["SMART", "FOOTNOTES", "UNSAFE"]
extensions: ["strikethrough", "autolink", "table", "tagfilter"]
highlighter: rouge
plugins:
# gh
- jekyll-coffeescript
- jekyll-commonmark
- jekyll-gist
- jekyll-github-metadata
- jekyll-relative-links
- jekyll-optional-front-matter
- jekyll-readme-index
- jekyll-default-layout
- jekyll-titles-from-headings
# custom
- jekyll-i18n_tags