mirror of https://github.com/thomasjsn/hugo-theme-hello-friend.git synced 2024-11-21 15:25:08 +01:00

blog hugo hugo-theme markdown nodejs personal-site postcss responsive webpack

Go to file

Guilherme Esteves b8e2f47429 add guilhermesteves.dev		2020-06-16 14:47:09 -03:00
exampleSite	[example] Correct img link of cover	2019-05-25 23:55:15 +05:30
images	Update screens	2019-01-06 11:59:15 +01:00
layouts	Merge branch 'master' into PR-rss	2020-05-27 17:00:25 +02:00
source	update source/css/menu.css	2020-05-20 18:59:18 -03:00
static	Update dependencies and prettier config	2020-01-27 18:26:12 +01:00
.eslintrc.yml	New Version - 1.0.1 — Set dark theme as default & fix eslint	2018-08-24 09:37:55 +02:00
.gitignore	Fix Webpack, PostCSS and related configs	2018-07-23 20:55:40 +02:00
.prettierrc	Update dependencies and prettier config	2020-01-27 18:26:12 +01:00
LICENSE.md	Update LICENSE.md	2019-01-29 18:11:40 +01:00
package.json	Update dependencies	2019-02-09 00:09:44 +01:00
postcss.config.js	Add submenu	2019-02-01 10:06:44 +01:00
README.md	Update README.md	2020-06-13 15:57:51 +02:00
theme.toml	Update theme.toml	2019-08-30 09:06:51 +02:00
USERS.md	add guilhermesteves.dev	2020-06-16 14:47:09 -03:00
webpack.config.js	Compile files	2019-02-01 10:13:10 +01:00
yarn.lock	Fix dependecies	2020-04-01 19:45:18 +02:00

README.md

Hello Friend

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

Hello Friend

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).
- eg: {{< imgproc "img/hello.png" Resize "250x" center />}}
- More detailed info on processing commands at https://gohugo.io/content-management/image-processing/

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

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`)
  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

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

Archive — Theme has built-in archive page for main content (see contentTypeName variable 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 your content dir. If you need multilangual archives, duplicate content/archive.md and add .Lang variable, eg: content/archive.pl.md (remember to change url in duplicated file).
Comments — for adding comments to your blog posts please take a look at layouts/partials/comments.html https://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 at layouts/partial/prepended_head.html https://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 at layouts/partial/extended_head.html https://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 at layouts/partial/extended_footer.html https://github.com/panr/hugo-theme-hello-friend/blob/master/layouts/partials/extended_footer.html

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 edit the theme

If you have to override 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.

Otherwise, if you really want to edit the theme, you need to install Node dependencies. To do so, go to the theme directory (from your Hugo root directory):

$ cd themes/hello-friend

and then run:

$ npm install
$ npm i yarn
$ yarn

How to contribute

If you spot any bugs, please use Issue Tracker or if you want to add a new feature directly please create a new Pull Request.

`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:

License

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