Skip to content
/ hugo-theme-hello-friend Public
forked from panr/hugo-theme-hello-friend

Pretty basic theme for Hugo that covers all of the essentials. All you have to do is start typing!

github.com/panr/hugo-theme-hello-friend/

License

MIT license
0 stars 1.2k forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

stefanomainardi/hugo-theme-hello-friend

BranchesTags
 
 

Repository files navigation

Hello Friend

Hello Friend

DEMO - https://hugo-hello-friend.now.sh/

Buy Me A Coffee

Features

  • dark/light mode, depending on your preferences (dark 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

Built-in shortcodes

  • 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;" >}}
  • figure (same as image, 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;" >}}
  • imgproc Hugo shortcode for image processing, plus additional position param [ left | center | right ] (optional).
  • 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 >}}

Code highlighting

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.

Improved RSS Feed

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.

How to start

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 clone it directly to your Hugo folder:

$ git clone https://github.com/panr/hugo-theme-hello-friend.git themes/hello-friend

If you don't want to make any radical changes, it's the best option, because you can get new updates when they are available. To do so, include it as a git submodule:

$ git submodule add https://github.com/panr/hugo-theme-hello-friend.git themes/hello-friend

⚠️ The theme needs at least Hugo version 0.74.x.

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"
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"

  # "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.

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.

Add-ons

How to (safely) edit the theme

If 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.

To change something directly in the theme, you have to go to themes/hello-friend and modify the files.

First, you need to install Node dependencies. To do so, go to the theme directory (from your Hugo root directory):

 $ cd themes/hello-friend

then run:

$ npm install
$ npm i yarn
$ yarn

After you modified the files you can run webpack in watch mode:

$ yarn dev

or rebuild theme

$ yarn build

To see the changes (remember to restart hugo server).

Found a bug?

If you spot any bugs, please use Issue Tracker or create a new Pull Request to fix the issue.

New cool idea or feature?

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! 🤗

Sponsoring

If you like my work and want to support the development of the project, now you can! Just:

Buy Me A Coffee

License

Copyright © 2019-2020 Radosław Kozieł (@panr)

The theme is released under the MIT License. Check the original theme license for additional licensing information.

About

Pretty basic theme for Hugo that covers all of the essentials. All you have to do is start typing!

github.com/panr/hugo-theme-hello-friend/

Resources

Readme

License

MIT license
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

13 tags

Packages

No packages published

Languages

  • HTML 45.3%
  • CSS 43.8%
  • JavaScript 10.9%