Hello Friend NG-HZ

A good way to see the capabilities of this theme is this site.

General information

This theme was highly inspired by the excellent hello-friend, hermit and hello-friend-ng themes.

Features

Theming: dark/light mode, depending on your preferences (dark is default, but you can change it)
Great reading experience
- (Default stack) Bookerly, Geomanist and Cascadia
- (Alternative) Bookerly with Inter UI font, made by Rasmus Andersson and Hack
Hugo native code highlighting
An easy way to modify the theme with Hugo tooling
Fully responsive
Support for social icons
Supports multiple authors and listings
Includes Liberapay
Codefolding
Author specific pages to support multiple authors
Categories and tags with word-clouds
Nix build system for hermetic builds
Webmention support (TBD)
Various Comment systems
Multiple Analytics Trackers
Multiple Search Back-ends
- stork
- Fuse JS
Netlify spoiler (optional)

How to start

You can download the theme manually by going to https://github.com/HaoZeke/hugo-theme-hello-friend-ng-hz.git and pasting it to themes/hello-friend-ng-hz in your root directory.

You can also clone it directly to your Hugo folder:

$ git clone https://github.com/HaoZeke/hugo-theme-hello-friend-ng-hz.git themes/hello-friend-ng-hz

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/HaoZeke/hugo-theme-hello-friend-ng-hz.git themes/hello-friend-ng-hz

Stork Search

In order to use the stork search the build system needs to generate the stork-posts.st file.

# exampleSite
cd exampleSite
hugo
stork build --input index.toml --output stork-posts.st

Where the stork installation instructions are here.

Fuse Search

The search is adopted from this gist, along with these subsequent blog posts by eddturtle and lonelydev.

Note that though this requires less setup; it adds some additional weight (like jquery). However, it also includes some fuzzy searching logic.

How to configure

The theme doesn't require any advanced configuration. Just copy the following config file. Note: There are more options to configure. Take a look into the config.toml in exampleSite.

baseurl = "/"
languageCode = "en-us"
theme = "hello-friend-ng-hz"

[params]
  dateform        = "Jan 2, 2006"
  dateformShort   = "Jan 2"
  dateformNum     = "2006-01-02"
  dateformNumTime = "2006-01-02 15:04 -0700"

  # Set disableReadOtherPosts to true in order to hide the links to other posts.
  disableReadOtherPosts = false

  # Metadata mostly used in document's head
  description = "My new homepage or blog"
  keywords = "homepage, blog"
  images = [""]

  # Directory name of your blog content (default is `content/posts`)
  contentTypeName = "posts"

  # Default theme "light" or "dark"
  defaultTheme = "dark"
  
# Needed for search
[outputFormats]
[outputFormats.TOML]
mediaType = "application/toml"

[outputs]
  home = ["HTML", "RSS", "TOML", "JSON"]

[taxonomies]
  tag      = "tags"
  category = "categories"
  author   = "author"
  search   = "search" # Necessary!

[params.search]
  enable = true
  backend = "fuse" # can be stork or fuse

[languages]
  [languages.en]
    title = "Hello Friend NG HZ"
    subtitle = "A simple theme for Hugo"
    keywords = ""
    copyright = ""
    readOtherPosts = "Read other posts"

    [languages.en.params.logo]
      logoText = "hello friend ng hz"
      logoHomeLink = "/"
    # or
    #
    # path = "/img/your-example-logo.svg"
    # alt = "Your example logo alt text"

  # And you can even create generic menu
  [[menu.main]]
    identifier = "blog"
    name       = "Blog"
    url        = "/posts"

How to run your site

From your Hugo root directory run:

$ hugo server -t hello-friend-ng-hz

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.

More things

Built-in shortcodes

`image`

Properties:

src (required)
alt (optional)
position (optional, default: left, options: [left, center, right])
style

Example:

{{< image src="/img/hello.png" alt="Hello Friend" position="center" style="border-radius: 8px;" >}}

`figure`

Properties:

src (required)
alt (optional)
position (optional, default: left, options: [left, center, right])
style (optional)
caption (optional)
captionPosition (optional, default: center, options: [left, center, right]),
captionStyle (optional)

Example:

{{< figure src="/img/hello.png" alt="Hello Friend" position="center" style="border-radius: 8px;" caption="Hello Friend!" captionPosition="right" captionStyle="color: red;" >}}

Code highlighting

Supported languages: Take a look here

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

Favicon

Use RealFaviconGenerator to generate these files, put them into your site's static folder:

android-chrome-192x192.png
android-chrome-512x512.png
apple-touch-icon.png
favicon-16x16.png
favicon-32x32.png
favicon.ico
mstile-150x150.png
safari-pinned-tab.svg
site.webmanifest

Available Social Icons:

codechef
codepen
docker
email
facebook
gitbook
github
gitlab
instagram
kaggle
keybase
mastodon
linkedin
podcasts-apple
podcasts-google
slack
stackoverflow
telegram
twitch
twitter
youtube
goodreads
calendly
google scholar
orcid
publons

If you need another one, just open an issue or create a pull request with the desired icon. :)

Known issues

There is a bug in Hugo that sometimes causes the main page not to render correctly. The reason is an empty taxonomy part. Related issue tickets: !14 !59.

Either you comment it out completely or you write the following in

[taxonomies]
  tag      = "tags"
  category = "categories"

How to edit the theme

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

$ cd themes/hello-friend-ng

and then run:

nix-shell
# For setting the right path
ln -s $NODE_PATH node_modules

Third Party

License

The theme is released under the MIT License.

gregoryg / hugo-theme-hello-friend-ng-hz Goto Github PK

hugo-theme-hello-friend-ng-hz's Introduction