Some enhancements have been made to Hugo’s internal RSS 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. 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.
You can also choose one of the 3 possibilities to install the theme:
as Hugo Module
as a standalone local directory
as a git submodule
⚠️ The theme needs at least Hugo Extended v0.90.x.
Install theme as Hugo Module
# If this is the first time you're using Hugo Modules# in your project. You have to initiate your own module before# you fetch the theme module.## hugo mod init [your website/module name]hugo mod get github.com/panr/hugo-theme-hello-friend
and in your config file add:
# this is needed when you fetch the theme as a submodule to your repo.# replacements = "github.com/panr/hugo-theme-hello-friend -> themes/hello-friend"[[module.imports]]
path = 'github.com/panr/hugo-theme-hello-friend'
Keep in mind that the theme by default won’t show up in the themes directory. This means that you are using the theme as it was on the repository at the moment you fetched it. Your local go.sum file keeps all the references. Read more about Hugo Modules in the official documentation.
⚠️ If you encounter any issues with:
Error: module "hello-friend" not found; either add it as a Hugo Module or store it in "[...your custom path]/themes".: module does not exist
then please try to remove theme = "hello-friend" from your config file.
This will install the repository as a sumbodule in the themes/hello-friend directory.
How to run your site
From your Hugo root directory run:
hugo server -t hello-friend
and go to localhost:1313 in your browser. From now on all the changes you make will go live, so you don’t need to refresh your browser every single time.
How to configure
The theme doesn’t require any advanced configuration. Just copy:
baseurl = "/"languageCode = "en-us"# Add it only if you keep the theme in the `themes` directory.# Remove it if you use the theme as a remote Hugo Module.theme = "hello-friend"paginate = 5[params]
# dir name of your blog content (default is `content/posts`).# the list of set content will show up on your index page (baseurl).contentTypeName = "posts"# OS theme is default when not provided, but you can force it to "light" or "dark"defaultTheme = "dark"# if you set this to 0, only submenu trigger will be visibleshowMenuItems = 2# Show reading time in minutes for postsshowReadingTime = false# Show table of contents at the top of your posts (defaults to false)# Alternatively, add this param to post front matter for specific posts# toc = true# Show full page content in RSS feed items#(default is Description or Summary metadata in the front matter)# rssFullText = true[languages]
title = "Hello Friend"subtitle = "A simple theme for Hugo"keywords = ""copyright = ""menuMore = "Show more"writtenBy = "Written by"readMore = "Read more"readOtherPosts = "Read other posts"newerPosts = "Newer posts"olderPosts = "Older posts"minuteReadingTime = "min read"dateFormatSingle = "2006-01-02"dateFormatList = "2006-01-02"# leave empty to disable, enter display text to enable# lastModDisplay = "" [languages.en.params.logo]
logoText = "hello friend"logoHomeLink = "/"# or## path = "/img/your-example-logo.svg"# alt = "Your example logo alt text" [languages.en.menu]
identifier = "about"name = "About"url = "/about" [[languages.en.menu.main]]
identifier = "showcase"name = "Showcase"url = "/showcase"
to config.toml file in your Hugo root directory and change params fields. In case you need, here’s a YAML version.
NOTE: Please keep in mind that currently main menu doesn’t support nesting.
How to add a cover image to your posts
Adding a cover image to your post is simple and there are two options when you edit your index.md file in content/posts/blog-entry-xy/index.md:
Use cover = "/path/to/absolute/img.jpg" to link an absolute image
Resulting in https://www.yourpage.com/path/to/absolute/img.jpg
Use cover = "img.jpg" and useRelativeCover = true to link the image relative to the blog post folder
Resulting in https://www.yourpage.com/posts/blog-entry-xy/img.jpg
Use coverAlt = "description of image" to add custom alt text to the cover image (defaults to post or page title as alt text)
Use coverCaption = "Image Credit to [Barry Bluejeans](https://unsplash.com/)" to add a caption for the cover image.
How to display the Last Modified Date in your posts
Add lastModDisplay = "[your display text]" to config.toml to enable last modified date on your posts. Note - an empty string value "" does not display anything.
Example: lastModDisplay = "Modified:" –> “Modified: Jan 01, 0001”
:octocat: Hugo’s enableGitInfo option is a nice complement to this feature.
How to hide “Read more” button
In a post’s front matter you have to add hideReadMore param set to true. This will result in that the post won’t have “Read more” button in the list view.
If you are using as a remote Hugo Module (you don’t have the theme files in the theme/hello-friend) and you have to override only some of the styles, you can do this easily by adding static/style.css in your root directory and point things you want to change.
If you have the theme files in the theme directory, then you can directly edit anything in the theme, you just have to go to themes/hello-friend and modify the files. No compilation step needed.
The theme is in constant development since 2019 and has got many cool features that helped many of you and made the theme better. But there were also many features that I wasn’t sure about because I want to keep the theme as simple as possible.
So, let’s say you have an idea of how to extend the theme. That’s cool and you’re welcome to do that, just follow these steps:
fork the theme
implement the feature
write an instruction how to use the feature
give a working example of the implementation for other users
add info about your work to COMMUNITY-FEATURES.md
make a PR with edited COMMUNITY-FEATURES.md
This will help keeping the theme close to its roots, and also allow anyone who wishes to improve it and match their needs, to do whatever they want.
Sounds OK? Cool, let’s rock! 🤘
Hello Friend theme user?
I’d be happy to know more about you and what you are doing. If you want to share it, please make a contribution and add your site to the list! 🤗