Overview

On this page

The header module is a universal top app bar that ships with some useful sub modules, such as social links, light/dark mode toggle and language picker.

Module PathVersion
github.com/razonyang/hb/modules/headerVersion

Site Parameters

ParameterTypeDefaultDescription
brandstringSite’s titleThe brand text.
themestring-Available themes: classic.
full_widthbooleantrueWhether to take full width.
stickybooleantrueWhether to sticky the header.

hugo.toml

1[params]
2  [params.hb]
3    [params.hb.header]
4      brand = ''
5      full_width = true
6      sticky = true
7      theme = ''

hugo.yaml

1params:
2  hb:
3    header:
4      brand: ""
5      full_width: true
6      sticky: true
7      theme: ""

hugo.json

 1{
 2   "params": {
 3      "hb": {
 4         "header": {
 5            "brand": "",
 6            "full_width": true,
 7            "sticky": true,
 8            "theme": ""
 9         }
10      }
11   }
12}