diff options
| author |  Inverle <inverle@proton.me>
| 2025-12-04 20:06:21 +0100 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2025-12-04 20:06:21 +0100 |
| commit | 5e9c3617cac1e3eac246e2ae7df6f4b71c33d37c (patch) | |
| tree | 435618816d2ccc5d29b21fa0c089f814972a2ce7 /docs/Gemfile | |
| parent | 78e40c6fe3afe7f815ef9d32646610e2d5436ba3 (diff) | |
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
Diffstat (limited to 'docs/Gemfile')
| -rw-r--r-- | docs/Gemfile | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/Gemfile b/docs/Gemfile new file mode 100644 index 000000000..76d06a741 --- /dev/null +++ b/docs/Gemfile @@ -0,0 +1,17 @@ +source "https://rubygems.org" + +gem "kramdown-parser-gfm" + +group :jekyll_plugins do + gem 'jekyll-coffeescript' + gem 'jekyll-commonmark-ghpages' + gem 'jekyll-gist' + gem 'jekyll-github-metadata' + gem 'jekyll-paginate' + gem 'jekyll-relative-links' + gem 'jekyll-optional-front-matter' + gem 'jekyll-readme-index' + gem 'jekyll-default-layout' + gem 'jekyll-titles-from-headings' + gem 'jekyll-i18n_tags' +end |