Even if the repository is archived you can still use the theme, fork it, download it, expand it, etc. Remember that each Hugo theme is a module that can be modified to match your needs. The theme is fully "open" and it depends only on the internal engines implemented in Hugo.
The theme brings many useful features thanks to all people that contributed to it (I want to thank you all!). At the time of archiving the theme has reached 14th place on the official Hugo Themes list. This is huge! Thanks to you!
- Hello Friend
- DEMO - https://hugo-hello-friend.now.sh/
- Features
- How to start
- How to run your site
- How to configure
- How to add a cover image to your posts
- How to display the Last Modified Date in your posts
- How to hide "Read more" button
- Add-ons
- How to edit the theme
- Found a bug?
- New cool idea or feature
Hello Friendtheme user?- License
- dark/light mode, depending on your preferences (the theme of your operating system is default, but you can change it)
- great reading experience thanks to Inter font, made by Rasmus Andersson
- nice code highlighting thanks to PrismJS
- fully responsive
image(prop required:src; props optional:alt,position(left is default | center | right),style)- eg:
{{< image src="/img/hello.png" alt="Hello Friend" position="center" style="border-radius: 8px;" >}}
- eg:
figure(same asimage, plus few optional props:caption,captionPosition(left | center is default | right),captionStyle- eg:
{{< figure src="/img/hello.png" alt="Hello Friend" position="center" style="border-radius: 8px;" caption="Hello Friend!" captionPosition="right" captionStyle="color: red;" >}}
- eg:
imgprocHugo shortcode for image processing, plus additionalpositionparam [ left | center | right ] (optional).- eg:
{{< imgproc "img/hello.png" Resize "250x" center />}} - More detailed info on processing commands at https://gohugo.io/content-management/image-processing/
- eg:
code(prop required:language; props optional:title,id,expand(default "△"),collapse(default "▽"),isCollapsed)- eg:
{{< code language="css" title="Really cool snippet" id="1" expand="Show" collapse="Hide" isCollapsed="true" >}} pre { background: #1a1a1d; padding: 20px; border-radius: 8px; font-size: 1rem; overflow: auto; @media ($phone) { white-space: pre-wrap; word-wrap: break-word; } code { background: none !important; color: #ccc; padding: 0; font-size: inherit; } } {{< /code >}}
By default the theme is using PrismJS to color your code syntax. All you need to do is to wrap you code like this:
```html // your code here ```
Supported languages: bash/shell, css, clike, javascript, apacheconf, actionscript, applescript, c, csharp, cpp, coffeescript, ruby, csp, css-extras, diff, django, docker, elixir, elm, markup-templating, erlang, fsharp, flow, git, go, graphql, less, handlebars, haskell, http, java, json, kotlin, latex, markdown, makefile, objectivec, ocaml, perl, php, php-extras, r, sql, processing, scss, python, jsx, typescript, toml, reason, textile, rust, sass, stylus, scheme, pug, swift, yaml, haml, twig, tsx, vim, visual-basic, wasm.
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 download the theme manually by going to https://github.com/panr/hugo-theme-hello-friend.git and pasting it to themes/hello-friend in your root directory.
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
# 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-friendand in your config file add:
[module]
# 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.
Error: module "hello-friend" not found; either add it as a Hugo Module or store it in "[...your custom path]/themes".: module does not existthen please try to remove theme = "hello-friend" from your config file.
git clone https://github.com/panr/hugo-theme-hello-friend.git themes/hello-friendThis will clone the repository directly to the themes/hello-friend directory.
git submodule add -f https://github.com/panr/hugo-theme-hello-friend.git themes/hello-friendThis will install the repository as a sumbodule in the themes/hello-friend directory.
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.
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 visible
showMenuItems = 2
# Show reading time in minutes for posts
showReadingTime = 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]
[languages.en]
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]
[[languages.en.menu.main]]
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.
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
- Resulting in
- Use
cover = "img.jpg"anduseRelativeCover = trueto link the image relative to the blog post folder- Resulting in
https://www.yourpage.com/posts/blog-entry-xy/img.jpg
- Resulting in
- 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.
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"
Hugo's enableGitInfo option is a nice complement to this feature.
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.
- Archive — Theme has built-in
archivepage for main content (seecontentTypeNamevariable in config). If you need archive on your blog just copy https://github.com/panr/hugo-theme-hello-friend/blob/master/exampleSite/content/archive.md to yourcontentdir. If you need multilangual archives, duplicatecontent/archive.mdand add.Langvariable, eg:content/archive.pl.md(remember to changeurlin duplicated file). - Comments — for adding comments to your blog posts please take a look at
layouts/partials/comments.htmlhttps://github.com/panr/hugo-theme-terminal/blob/master/layouts/partials/comments.html. - Prepended
<head>— if you need to add something inside<head>element, and before any of the theme's<script>and<link>tags are declared, please take a look atlayouts/partial/prepended_head.htmlhttps://github.com/panr/hugo-theme-hello-friend/blob/master/layouts/partials/prepended_head.html - Extended
<head>— if you need to add something inside<head>element, after all of all of the theme's<script>and<link>tags are declared, please take a look atlayouts/partial/extended_head.htmlhttps://github.com/panr/hugo-theme-hello-friend/blob/master/layouts/partials/extended_head.html - Extended
<footer>— if you need to add something before end of<body>element, please take a look atlayouts/partial/extended_footer.htmlhttps://github.com/panr/hugo-theme-hello-friend/blob/master/layouts/partials/extended_footer.html
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.
If you spot any bugs, please use Issue Tracker or create a new Pull Request to fix the issue.
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! 🤘
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! 🤗
Copyright © 2019-2022 Radosław Kozieł (@panr)
The theme is released under the MIT License. Check the original theme license for additional licensing information.
![@dependabot[bot]](https://avatars.githubusercontent.com/in/29110?s=64&v=4){kind=small}
