diff options
author | Robert Austin <rob@jugglerdigital.com> | 2020-08-19 15:46:33 +0300 |
---|---|---|
committer | Robert Austin <rob@jugglerdigital.com> | 2020-08-19 15:46:33 +0300 |
commit | 88f695c03c20c00cc4d5bf813f0c7de82954b09b (patch) | |
tree | 7245770c38c7f01e9775898c342f31fb9739c8b0 | |
parent | 8343acea0d5669d7a3a0a148a15c2e21b2453d3b (diff) |
add github logo, remove header block
-rw-r--r-- | README.md | 45 | ||||
-rw-r--r-- | exampleSite/config.toml | 5 | ||||
-rw-r--r-- | exampleSite/content/services/accounting.md | 2 | ||||
-rw-r--r-- | exampleSite/content/services/business-advisory.md | 1 | ||||
-rw-r--r-- | exampleSite/content/services/business-sales.md | 1 | ||||
-rw-r--r-- | exampleSite/content/services/mergers.md | 1 | ||||
-rw-r--r-- | exampleSite/content/services/superannuation.md | 1 | ||||
-rw-r--r-- | exampleSite/content/services/tax-preperation.md | 2 | ||||
-rw-r--r-- | exampleSite/static/images/github.svg | 1 | ||||
-rw-r--r-- | layouts/_default/baseof.html | 2 | ||||
-rw-r--r-- | layouts/_default/list.html | 2 | ||||
-rw-r--r-- | layouts/index.html | 2 | ||||
-rw-r--r-- | layouts/page/contact.html | 2 | ||||
-rw-r--r-- | layouts/partials/header.html | 1 | ||||
-rw-r--r-- | layouts/partials/main-menu.html | 5 | ||||
-rw-r--r-- | layouts/services/list.html | 2 | ||||
-rw-r--r-- | layouts/services/single.html | 2 | ||||
-rw-r--r-- | layouts/team/list.html | 2 | ||||
-rw-r--r-- | stackbit.yaml | 7 |
19 files changed, 58 insertions, 28 deletions
@@ -2,7 +2,7 @@ Serif is a modern business theme for Hugo. It contains content types for the archetypical business website. The theme is fully responsive, blazing fast and artfully illustrated. -[Live Demo](https://hugo-serif.netlify.com/) | +[Live Demo](https://hugo-serif.netlify.app/) | [Zerostatic Themes](https://www.zerostatic.io/theme/hugo-serif/) ![Hugo Serif Theme screenshot](https://github.com/JugglerX/hugo-serif-theme/blob/master/images/screenshot.png) @@ -19,41 +19,55 @@ Serif is a modern business theme for Hugo. It contains content types for the arc - SCSS (Hugo Pipelines) - Responsive design -- Bootstrap 4.3 grid and media queries only +- Bootstrap 4.4 grid and media queries only +- Uncomment `@import 'bootstrap/bootstrap';` in `style.scss` to use the entire Bootstrap framework ### Speed - 100/100 Google Lighthouse speed score -- Under 30KB without images or 80KB with images and illustrations ⚡ +- Under 50KB without images or 80KB with images and illustrations ⚡ - No jQuery, only a tiny bit of vanilla Javascript for the mobile menu. ### SEO +- 100/100 Google Lighthouse SEO score - Google analytics configured in `config.toml` - Configure GID using env variable HUGO_GOOGLE_ANALYTICS_ID, compatible with Netlify. - Configure meta tags and OG meta tags for the homepage in `config.toml` - Override any meta tags on a per page basis -- Semantic document structure -- Accessible colors, headings and link text +- Semantic HTML document structure + +### Accessibility + +- 100/100 Google Lighthouse accessibility score +- Accessible colors, headings and link text (by design) +- Attention has been paid to using correct contrast, font sizes etc +- Attention has been paid to ensuring comfortable hit zones and link sizing on mobile ### Menu - Responsive menu managed in `config.toml` +- Animated hamburger menu on mobile ### Content - Robust example content included - Royalty free illustrations included -- Set `body` classes on a per template basis ### Templating -- Plenty of examples of using `range` and `where` to loop over various content types +- No hardcoded content in the layouts +- Plenty of examples of using `range` and `where` to loop over various sections/content types +- Examples of `range` by Param +- Examples of using data content _(data/contact.yaml and data/features.json)_ +- Example of passing .Site . (context) and custom variables to partials - see `layouts/page/contact.html` - `{{ partial "call.html" (dict "site" .Site "context" . "show_button" "false") }}` - Examples of injecting javascript files on a per page basis (see services/single.html) +- Set `body` classes from individual layouts - useful for CSS styling. +- Example of using Hugo custom `layout` for the contact page # Stackbit Deploy -This theme is is ready to import into Stackbit. This will deploy the site to Netlify and optionally you can select a headless CMS so you can edit the content without ever touching the code. +Use Stackbit to deploy this theme to Netlify and connect any headless CMS _(Forestry, NetlifyCMS, Sanity, Contentful, DatoCMS)_ - Actually really amazing. [![Create with Stackbit](https://assets.stackbit.com/badge/create-with-stackbit.svg)](https://app.stackbit.com/create?theme=https://github.com/JugglerX/hugo-serif-theme) @@ -139,15 +153,22 @@ Now enter [`localhost:1313`](http://localhost:1313) in the address bar of your b # Configuring theme features +Copy your Google Analytics id into the `config.toml` - Also supports Google Tag Manager. + +### Google Analytics +``` +// config.toml +[params] + google_analytics_id = "" + google_tag_manager_id = "" +``` + ### Homepage meta tags Often a homepage requires special meta tags such as a meta 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" @@ -160,7 +181,7 @@ Often a homepage requires special meta tags such as a meta description or og met meta_twitter_creator = "@mytwitterhandle" ``` -### Set meta tags on a per template/page basis +### Override meta tags on a per layout 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. diff --git a/exampleSite/config.toml b/exampleSite/config.toml index fb937d9..612b06d 100644 --- a/exampleSite/config.toml +++ b/exampleSite/config.toml @@ -19,13 +19,16 @@ theme = "hugo-serif-theme" meta_description = "Serif is a modern business theme for Hugo. It contains content types for the archetypical business website. The theme is fully responsive, blazing fast and artfully illustrated." meta_og_title = "Hugo Serif Theme" meta_og_type = "website" - meta_og_url = "https://hugo-serif.netlify.com" + meta_og_url = "https://hugo-serif.netlify.app" meta_og_image = "https://raw.githubusercontent.com/JugglerX/hugo-serif-theme/master/images/tn.png" meta_og_description = "Serif is a modern business theme for Hugo. It contains content types for the archetypical business website. The theme is fully responsive, blazing fast and artfully illustrated." meta_twitter_card = "summary" meta_twitter_site = "@zerostaticio" meta_twitter_creator = "@zerostaticio" + [params.header] + github_link = "https://github.com/JugglerX/hugo-serif-theme" + [menu] # Main Menu [[menu.main]] diff --git a/exampleSite/content/services/accounting.md b/exampleSite/content/services/accounting.md index d799416..e8aae80 100644 --- a/exampleSite/content/services/accounting.md +++ b/exampleSite/content/services/accounting.md @@ -8,7 +8,7 @@ weight: 1 Financial accounting (or financial accountancy) is the field of accounting concerned with the **summary, analysis and reporting** of financial transactions related to a business. -![Accounting Services](/services/austin-distel-nGc5RT2HmF0-unsplash.jpg) +![Accounting Services](/images/austin-distel-nGc5RT2HmF0-unsplash.jpg) # Objectives diff --git a/exampleSite/content/services/business-advisory.md b/exampleSite/content/services/business-advisory.md index 734e3cc..5337f66 100644 --- a/exampleSite/content/services/business-advisory.md +++ b/exampleSite/content/services/business-advisory.md @@ -3,6 +3,7 @@ title: "Business Advisory" date: 2018-11-28T15:14:39+10:00 featured: true draft: false +weight: 2 --- Lorem markdownum, dictis umbrosum dextrum, Lelegeia quamquam distantes pares diff --git a/exampleSite/content/services/business-sales.md b/exampleSite/content/services/business-sales.md index 4bd07a3..50bc996 100644 --- a/exampleSite/content/services/business-sales.md +++ b/exampleSite/content/services/business-sales.md @@ -3,6 +3,7 @@ title: "Business Sales" date: 2018-11-28T15:15:26+10:00 featured: true draft: false +weight: 3 --- Cyanee nec pedicis positi. Esse et diem forte quoque et ieiunia diff --git a/exampleSite/content/services/mergers.md b/exampleSite/content/services/mergers.md index 58ef584..ea9ac2b 100644 --- a/exampleSite/content/services/mergers.md +++ b/exampleSite/content/services/mergers.md @@ -3,6 +3,7 @@ title: "Mergers" date: 2018-11-28T15:15:34+10:00 featured: true draft: false +weight: 4 --- Lorem markdownum aequalis strigis. Saetigeri iubeas, vultu huic alvum nondum diff --git a/exampleSite/content/services/superannuation.md b/exampleSite/content/services/superannuation.md index b9ff7b7..6a435f6 100644 --- a/exampleSite/content/services/superannuation.md +++ b/exampleSite/content/services/superannuation.md @@ -3,6 +3,7 @@ title: "Superannuation" date: 2018-11-28T15:14:54+10:00 featured: true draft: false +weight: 5 --- Lorem markdownum aequalis strigis. Saetigeri iubeas, vultu huic alvum nondum diff --git a/exampleSite/content/services/tax-preperation.md b/exampleSite/content/services/tax-preperation.md index 5262f07..c07aef0 100644 --- a/exampleSite/content/services/tax-preperation.md +++ b/exampleSite/content/services/tax-preperation.md @@ -3,7 +3,7 @@ title: "Tax Preperation" date: 2018-11-18T12:33:46+10:00 draft: false featured: true -weight: 2 +weight: 6 --- Lorem markdownum **Achaica revolutaque amore**, penitus puppes nec furit, diff --git a/exampleSite/static/images/github.svg b/exampleSite/static/images/github.svg new file mode 100644 index 0000000..3899712 --- /dev/null +++ b/exampleSite/static/images/github.svg @@ -0,0 +1 @@ +<svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>GitHub icon</title><path d="M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12"/></svg>
\ No newline at end of file diff --git a/layouts/_default/baseof.html b/layouts/_default/baseof.html index da4981e..d7da1b4 100644 --- a/layouts/_default/baseof.html +++ b/layouts/_default/baseof.html @@ -8,7 +8,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1"> {{ block "meta_tags" . }}{{end}} <link rel="icon" type="image/png" href="{{ "favicon-32x32.png" | relURL }}"> - <link href="https://fonts.googleapis.com/css2?family=Playfair+Display&display=swap" rel="stylesheet"> + <link href="https://fonts.googleapis.com/css2?family=Playfair+Display:wght@400;700&display=swap" rel="stylesheet"> <!-- CSS--> {{ if .Site.IsServer }} diff --git a/layouts/_default/list.html b/layouts/_default/list.html index 3d25ce8..38b2fe9 100644 --- a/layouts/_default/list.html +++ b/layouts/_default/list.html @@ -1,6 +1,4 @@ -{{ define "header_css" }}{{ end }} {{ define "body_classes" }}page-default-list{{ end }} -{{ define "header_classes" }}{{ end }} {{ define "main" }} <div class="intro"> diff --git a/layouts/index.html b/layouts/index.html index 98a57f3..5801931 100644 --- a/layouts/index.html +++ b/layouts/index.html @@ -1,7 +1,5 @@ {{ define "title" }}{{ .Site.Title }}{{ end}} -{{ define "header_css" }}{{ end }} {{ define "body_classes" }}page-home{{ end }} -{{ define "header_classes" }}header-transparent{{ end }} {{ define "meta_tags" }} <meta name="description" content="{{ .Site.Params.homepage_meta_tags.meta_description }}" /> diff --git a/layouts/page/contact.html b/layouts/page/contact.html index 7dc60da..9fcc776 100644 --- a/layouts/page/contact.html +++ b/layouts/page/contact.html @@ -1,6 +1,4 @@ -{{ define "header_css" }}{{ end }} {{ define "body_classes" }}page-contact{{ end }} -{{ define "header_classes" }}{{ end }} {{ define "main" }} <div class="container pb-6 pt-6 pt-md-10 pb-md-10"> diff --git a/layouts/partials/header.html b/layouts/partials/header.html index 1dcc422..4da4375 100644 --- a/layouts/partials/header.html +++ b/layouts/partials/header.html @@ -8,5 +8,6 @@ </div> {{ partial "main-menu.html" . }} {{ partial "hamburger.html" . }} + </div> </div> diff --git a/layouts/partials/main-menu.html b/layouts/partials/main-menu.html index 924c91b..bcd3a17 100644 --- a/layouts/partials/main-menu.html +++ b/layouts/partials/main-menu.html @@ -9,5 +9,10 @@ </a> </li> {{end}} + {{ if .Site.Params.header.github_link }} + <a href="{{ .Site.Params.header.github_link }}"> + <svg role="img" viewBox="0 0 24 24" width="20" height="20" xmlns="http://www.w3.org/2000/svg"><title>GitHub icon</title><path d="M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12"/></svg> + </a> + {{ end }} </ul> </div>
\ No newline at end of file diff --git a/layouts/services/list.html b/layouts/services/list.html index 18f12eb..0a810c5 100644 --- a/layouts/services/list.html +++ b/layouts/services/list.html @@ -1,6 +1,4 @@ -{{ define "header_css" }}{{ end }} {{ define "body_classes" }}page-services-list{{ end }} -{{ define "header_classes" }}{{ end }} {{ define "main" }} <div class="intro"> diff --git a/layouts/services/single.html b/layouts/services/single.html index 5f55883..ef4a7fd 100644 --- a/layouts/services/single.html +++ b/layouts/services/single.html @@ -1,6 +1,4 @@ -{{ define "header_css" }}{{ end }} {{ define "body_classes" }}page-services-single{{ end }} -{{ define "header_classes" }}{{ end }} {{ define "main" }} <div class="container pb-6 pt-6 pt-md-10 pb-md-10"> diff --git a/layouts/team/list.html b/layouts/team/list.html index 6dd6de2..e78ca82 100644 --- a/layouts/team/list.html +++ b/layouts/team/list.html @@ -18,8 +18,6 @@ </div> </div> - - <div class="container"> <div class="row"> {{ range where .Pages.ByWeight ".Params.promoted" true }} diff --git a/stackbit.yaml b/stackbit.yaml index 02d430e..0e52dc0 100644 --- a/stackbit.yaml +++ b/stackbit.yaml @@ -95,6 +95,13 @@ models: - type: string name: meta_twitter_creator label: meta_twitter_creator + - type: object + name: header + label: Header + fields: + - type: string + name: github_link + label: Github Link - type: site_menus name: menu label: Menus |