From f35a6c88a1e8341946a1d6b41ee2b956d2442428 Mon Sep 17 00:00:00 2001 From: Adam Ormsby Date: Wed, 20 May 2020 13:59:33 -0500 Subject: [PATCH] add rss image --- README.md | 38 +++++++++++++++++++------------------- layouts/_default/rss.xml | 8 ++++++++ 2 files changed, 27 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index eb4dd90..ade0a6a 100644 --- a/README.md +++ b/README.md @@ -10,24 +10,22 @@ This theme is pretty basic and covers all of the essentials. All you have to do --- -- [Hello Friend](#hello-friend) - - [DEMO - https://hugo-hello-friend.now.sh/](#demo---httpshugo-hello-friendnowsh) - - [Features](#features) - - [Built-in shortcodes](#built-in-shortcodes) - - [Code highlighting](#code-highlighting) - - [Improved RSS Feed](#improved-rss-feed) - - [How to start](#how-to-start) - - [How to configure](#how-to-configure) - - [How to add a cover image to your posts](#how-to-add-a-cover-image-to-your-posts) - - [How to display the Last Modified Date in your posts](#how-to-display-the-last-modified-date-in-your-posts) - - [How to hide "Read more" button](#how-to-hide-%22read-more%22-button) - - [Add-ons](#add-ons) - - [How to run your site](#how-to-run-your-site) - - [How to edit the theme](#how-to-edit-the-theme) - - [How to contribute](#how-to-contribute) - - [`Hello Friend` theme user?](#hello-friend-theme-user) - - [Sponsoring](#sponsoring) - - [License](#license) +- [Features](#features) + - [Built-in shortcodes](#built-in-shortcodes) + - [Code highlighting](#code-highlighting) + - [Improved RSS Feed](#improved-rss-feed) +- [How to start](#how-to-start) +- [How to configure](#how-to-configure) +- [How to add a cover image to your posts](#how-to-add-a-cover-image-to-your-posts) +- [How to display the Last Modified Date in your posts](#how-to-display-the-last-modified-date-in-your-posts) +- [How to hide "Read more" button](#how-to-hide-read-more-button) +- [Add-ons](#add-ons) +- [How to run your site](#how-to-run-your-site) +- [How to edit the theme](#how-to-edit-the-theme) +- [How to contribute](#how-to-contribute) +- [`Hello Friend` theme user?](#hello-friend-theme-user) +- [Sponsoring](#sponsoring) +- [License](#license) ## Features @@ -58,12 +56,14 @@ By default the theme is using PrismJS to color your code syntax. All you need to #### Improved RSS Feed -Some small enhancements have been made to Hugo's [internal RSS](https://github.com/gohugoio/hugo/blob/25a6b33693992e8c6d9c35bc1e781ce3e2bca4be/tpl/tplimpl/embedded/templates/_default/rss.xml) generation code. +Some enhancements have been made to Hugo's [internal RSS](https://github.com/gohugoio/hugo/blob/25a6b33693992e8c6d9c35bc1e781ce3e2bca4be/tpl/tplimpl/embedded/templates/_default/rss.xml) generation code. **A page's cover image now appears at the top of its feed display**. This image is set manually using [the cover params](#how-to-add-a-cover-image-to-your-posts). If unset, the RSS generator searches for the first image file in the page bundle whose name includes 'featured', 'cover', or 'thumbnail'. **You can optionally display the full page content in your RSS feed** (default is Description or Summary data from Front Matter). Set `rssFullText = true` in your `config.toml` file to enable this option. +**You can choose a site image to be displayed when searching for your RSS feed.** Set `rssImage = "image/url/here"` in your `config.toml` file to enable this option. + ## How to start You can download the theme manually by going to [https://github.com/panr/hugo-theme-hello-friend.git](https://github.com/panr/hugo-theme-hello-friend.git) and pasting it to `themes/hello-friend` in your root directory. diff --git a/layouts/_default/rss.xml b/layouts/_default/rss.xml index 4176413..696cf60 100644 --- a/layouts/_default/rss.xml +++ b/layouts/_default/rss.xml @@ -14,6 +14,14 @@ {{ if eq .Title .Site.Title }}{{ .Site.Title }}{{ else }}{{ with .Title }}{{.}} on {{ end }}{{ .Site.Title }}{{ end }} + + {{ if .Site.Params.RssImage }} + {{ printf "%s%s" .Permalink .Site.Params.RssImage }} + {{ if eq .Title .Site.Title }}{{ .Site.Title }}{{ else }}{{ with .Title }}{{.}} on {{ end }}{{ .Site.Title }}{{ end }} + {{ .Permalink }} + + {{ end }} + {{ .Permalink }} Recent content {{ if ne .Title .Site.Title }}{{ with .Title }}in {{.}} {{ end }}{{ end }}on {{ .Site.Title }} Hugo -- gohugo.io{{ with .Site.LanguageCode }}