Hero is a modern fullwidth business theme for Hugo.
Clone or download
Latest commit b295a29 Jan 12, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
archetypes first commit, unfinished Dec 5, 2018
assets fix header bg Jan 11, 2019
exampleSite update og:image Jan 12, 2019
images optimize images Jan 5, 2019
layouts tweak about Jan 12, 2019
static/images remove more images Jan 12, 2019
.gitignore test netlify.toml from exampleSite for netlify build Jan 7, 2019
LICENSE first commit, unfinished Dec 5, 2018
README.md update og:image Jan 12, 2019
netlify.toml update netlify baseurl Jan 11, 2019
theme.toml update theme description Jan 2, 2019

README.md

Hugo Hero Theme

Hero is a multipurpose theme with fullscreen hero images and fullwidth sections. It contains content types for a business or portfolio site.

Live Demo

Hugo Hero Theme screenshot

Theme features

Content Types

  • Services (Markdown)
  • Work/Portfolio (Markdown)
  • Features (Data)
  • About (Single Page)
  • Homepage (Single Page)

Features

  • Full-width/full-height hero image partial. Partial accepts a background-image, no background-image, background-image with blue overlay or just a blue color background.
  • Full width strips on homepage and about us page
  • Single 'About' page with alternating full-width sections
  • Portfolio pages contain a CSS only masonary image gallery

Content Management

  • The "Home" page uses multiple markdown files for the different homepage sections. It uses headless bundles.
  • The "About Us" page uses multiple markdown files for its different sections. It uses leaf bundles and shortcodes.
  • Services & Work are fully markdown driven with list, single and summary views.

CSS

  • SCSS (Hugo Pipelines)
  • Responsive design
  • Bootstrap 4 grid and media queries only

Speed

  • 100/100 Google Lighthouse speed score
  • 21KB without images ⚡
  • Vanilla JS only

Menu

  • Responsive mobile menu managed in config.toml

Content

  • Robust example content included
  • Royalty free images included

Installation

Installing Hugo

If you have not already installed Hugo on your machine please follow the official installation guide - Once Hugo is installed you may continue with the steps below.

Create a new Hugo Site

Create a new Hugo site

hugo new site mynewsite

This will create a new Hugo site in the folder mynewsite. Next you need to install this theme in the sites themes folder mynewsites/themes

You may do this by git cloning this repo into the themes folder.

cd mynewsite
cd themes
git clone https://github.com/jugglerx/hugo-hero-theme.git

Alternatively you may download the .zip file located here https://github.com/JugglerX/hugo-hero-theme/archive/master.zip. Extract the .zip inside the themes folder. Rename the theme from hugo-hero-theme-master -> hugo-hero-theme. You should end up with the following folder structure mynewsites/themes/hugo-hero-theme

Adding the example content

The fastest way to get started is to copy the example content. Copy the contents of the exampleSite folder to the root folder of your Hugo site. This theme comes with content for the following content types: services and work. The about us page is a single page with alternating fullwidth sections. It includes JSON data for features and contact. It also includes the config.toml file which has an example menu.

Updating config.toml

After you copy the config.toml into the root folder of your Hugo site you will need to update the baseURL, themesDir and theme values in the config.toml

baseURL = "/"
themesDir = "themes" // you can also remove this line
theme = "hugo-hero-theme" // or whatever you rename the theme folder too

Running Hugo

After installing the theme, generate the Hugo site.

hugo

Hugo's built-in local server.

hugo server

Now enter localhost:1313 in the address bar of your browser.

Running Hugo From within exampleSite

If you have just cloned/downloaded the theme and have not placed it inside an existing Hugo site you can still run the theme against the exampleSite locally using the following command.

from the theme directory (1 level above exampleSite) run:

hugo server --source exampleSite --config exampleSite/config.toml --themesDir ../.. --theme hugo-hero-theme

This is a less standard approach but may be convenient for some, particularly those who wish to maintain a single theme repo and also deploy a live demo to Netlify.

See this discussion on how to deploy your site on Netlify from the exampleSite folder - https://discourse.gohugo.io/t/deploy-your-theme-to-netlify/15508

Configuring Theme Features

Homepage meta tags

Often the homepage requires special meta tags such as a description or og meta data for twitter, facebook etc. You can configure these values in the config.toml

// config.toml
[params]
  google_analytics_id=""

  [params.homepage_meta_tags]
    meta_description = "a description of your website."
    meta_og_title = "My Theme"
    meta_og_type = "website"
    meta_og_url = "https://www.mywebsite.com"
    meta_og_image = "https://www.mywebsite.com/images/tn.png"
    meta_og_description = "a description of your website."
    meta_twitter_card = "summary"
    meta_twitter_site = "@mytwitterhandle"
    meta_twitter_creator = "@mytwitterhandle"

Set meta tags on a per template/page basis

You can set meta tags on a per template basis using a block. For example, you might want to write a custom <meta description> for the /services page. You can insert any valid HTML meta data inside the {{ define "meta_tags }} block at the top of a template.

// layouts/services/list.html
...

{{ define "meta_tags" }}
    <meta name="description" content="We offer a variety of services in the finance industry" />
{{ end }}

{{ define main }}
...