Header Module on HB Framework

HB Header Git Repository Module

Mon, 01 Jan 2024 20:50:05 +0800

Module	`github.com/hbstack/header/modules/git-repo`
Repository	⭐ Please consider giving a star if your like it.
Stars
Version
Used by
Requirements
License
Usage	See how to use modules.

HB core module

Parameters

params.toml

HB Header Git Organization Module

Mon, 01 Jan 2024 20:40:05 +0800

Module	`github.com/hbstack/header/modules/git-org`
Repository	⭐ Please consider giving a star if your like it.
Stars
Version
Used by
Requirements
License
Usage	See how to use modules.

HB Framework Git Organization

Parameters

params.toml

Header News Module

Wed, 01 Nov 2023 19:06:50 +0800

Module	`github.com/hbstack/header/modules/news`
Repository	⭐ Please consider giving a star if your like it.
Stars
Version
Used by
Requirements
License
Usage	See how to use modules.

Site Parameters

Parameter	Type	Default	Description
`sections`	`array`	`[news]`	Main sections.
`limit`	`number`	`5`	The maximum number of news.
`date_format`	`string`	`:date_full`	The format of news date.
`icon_name`	`string`	`bell-fill`	The name of icon.
`icon_vendor`	`string`	`bootstrap`	The name of icon vendor.

Header Google Custom Search Engine Module

Thu, 12 Oct 2023 20:11:15 +0800

Module	`github.com/hbstack/header/modules/gcse`
Repository	⭐ Please consider giving a star if your like it.
Stars
Version
Used by
Requirements
License
Usage	See how to use modules.

Site Parameters

hugo.toml

1[params]
2 [params.hb]
3 [params.hb.header]
4 [params.hb.header.gcse]
5 id = 'SEARCH_ENGINE_ID'
6 layout = 'offcanvas'

hugo.yaml

Header Banner

Sat, 26 Aug 2023 13:40:01 +0800

Module	`github.com/hbstack/header/modules/banner`
Repository	⭐ Please consider giving a star if your like it.
Stars
Version
Used by
Requirements
License
Usage	See how to use modules.

Properties

Name	Type	Required	Default	Description
`img`	string	Y	-	The image URL, you should at least specify the `img` or `video`.
`video`	object	Y	-	The video.
`video.src`	string	Y	-	The video URL.
`video.poster`	string	Y	-	The video poster.
`video.type`	string	Y	-	The video media type, i.e. `application/x-mpegURL` (HLS), `application/dash+xml` (MPEG DASH).
`alignment`	string	-	`start`	The alignment of content, `start`, `center` or `end`.
`color`	string	-	`#fff`	The content color.
`cols`	string	-	`12 lg:8`	How many columns does content take, `col-12 col-lg-8` by default.
`title`	boolean/string	-	Page title	The banner title, Markdown is supported, hidden when `false`.
`description`	boolean/string	-	Page description	The banner description, supports Markdown syntax, hidden when `false`.

Site Parameters

Tweak the hb.header.banner site parameters to enable the banner all of the pages.

Header Themes

Thu, 27 Jul 2023 20:59:06 +0800

Header Pills Theme

Module	`github.com/hbstack/header/themes/pills`
Repository	⭐ Please consider giving a star if your like it.
Stars
Version
Used by
Requirements
License
Usage	See how to use modules.

Header Classic Theme

Module	`github.com/hbstack/header/themes/classic`
Repository	⭐ Please consider giving a star if your like it.
Stars
Version
Used by
Requirements
License
Usage	See how to use modules.

Header Tabs Theme

Header DocSearch Module

Fri, 21 Apr 2023 01:52:36 +0800

DocSearch is a free online search service for open source documentation sites.

Header Menus

Fri, 17 Feb 2023 00:43:12 +0800

This article describes how to configure the header’s menus.

Header's Language Picker Module

Fri, 17 Feb 2023 00:06:59 +0800

The header’s language picker module for users to switch supported languages, it’s useful for multilingual sites.

Header Search Module

Fri, 17 Feb 2023 00:06:59 +0800

The header’s search module displays a search form and button to open the search modal.

Header Socials Module

Fri, 17 Feb 2023 00:06:59 +0800

The header’s socials generates social links.

Header Theme Toggle Module

Fri, 17 Feb 2023 00:06:59 +0800

The header’s theme toggle module for switching light, dark or auto (follow system) color mode.

Header Overview

Thu, 16 Feb 2023 23:58:05 +0800

Module	`github.com/hbstack/header`
Repository	⭐ Please consider giving a star if your like it.
Stars
Version
Used by
Requirements
License
Usage	See how to use modules.

Site Parameters

Parameter	Type	Default	Description
`brand`	string	Site’s title	The brand text.
`breakpoint`	string	`lg`	Collapse the header when screen width is less than the breakpoint, otherwise expand. Available options: `lg`, `xl`, `xxl`.
`full_width`	boolean	`true`	Whether to take full width.
`logo`	boolean	-	When `false` hide the logo.
`logo_bg`	string	-	Logo background color, used by transparent logo.
`main_brand`	object	-	Main brand.
`main_brand.title`	string	-	Main brand title.
`main_brand.logo`	string	-	Main brand logo, relative to `assets`.
`main_brand.url`	string	-	Main brand URL.
`main_brand.hide_title`	boolean	`false`	Whether to hide main brand title.
`menus_alignment`	string	`start`	Menus alignment: `start`, `center` and `end`.
`sticky`	boolean	`true`	Whether to sticky the header.
~~`theme`~~	string	-	Removed since `v0.4.0`, see themes.

The logo parameter belongs to core module.