The github.com/hbstack/hb is the core module of HB framework, which automatically loads and compiles the module’s SCSS and TypeScript, as well as rendering HTML.
This article describes how to configure the header’s menus.
The header’s search module displays a search form and button to open the search modal.
DocSearch is a free online search service for open source documentation sites.
The header’s socials generates social links.
The header’s theme toggle module for switching light, dark or auto (follow system) color mode.
The header’s language picker module for users to switch supported languages, it’s useful for multilingual sites.
This module is a universal footer, which ships with menus and some useful sub modules, i.e. social links.
This article describes how to configure the footer’s menus.
Beian (备案 in pinyin), it was designed for Chinese sites that display links about ICP records.
The list of footer’s custom hooks.
The footer’s socials generates social links.
The blog module provides the basic layouts and templates for blog site.
The blog module supports multiple authors by default.
The blog module supports an optional sidebar layout.
This module shows the recent and featured posts on the blog’s sidebar.
This module shows the taxonomies on the blog’s sidebar.
This module display the breadcrumb for blog layouts.
This module integrates content panel with blog module.
The list of blog’s custom hooks.
The post nav module generates the menus below the post content, to navigate to previous and next posts of same sections.
Automatically update table of content navigation to indicate which heading is currently active in the viewport.
This module integrate the Staticman comments module with blog layout.
This module adds support for the Giscus comments engine, which powered by GitHub Discussions.
This module add support for the Twikoo, a simple, safe and free comments system.
This module adds support for the Utterances comments engine, which built on top of GitHub issues.
This module adds support for the Disqus comments engine.
This module adds support for the Emote comments engine.
This module shows the featured image above the post content if present.
The heading sign module shows the section sign (anchor link) when hovering on headings.
This module shows the related posts below the post content.
The docs module provides the basic layouts and templates for docs site, it’s useful for writing project documentation, digital garden, users guides and tutorials.
This module integrate the Staticman comments module with docs layout.
This module adds support for the Disqus comments engine.
This module adds support for the Giscus comments engine, which powered by GitHub Discussions.
This module add support for the Twikoo, a simple, safe and free comments system.
This module adds support for the Emote comments engine.
This module adds support for the Utterances comments engine, which built on top of GitHub issues.
The doc nav module generates the menus for navigating to previous and next docs of same sections.
This module display the breadcrumb for docs layout.
This module integrates content panel with blog module.
This module shows the featured image above the doc content if present.
The heading sign module shows the section sign when hovering on headings.
The list of docs’s custom hooks.
Automatically update table of content navigation to indicate which heading is currently active in the viewport.
The gallery module provides a simple layout for images.
This module display the breadcrumb for gallery layout.
The list of gallery’s custom hooks.
The meta modules do not provide any functionalities, they are just a set of modules, to simplify the installation and uninstallation of the modules.
This module ships with an universal inline frame shortcode.
This module ports Bootstrap module to HB, to add missing components.
Mermaid is a JavaScript-based diagramming and charting tool that uses Markdown-inspired text definitions and a renderer to create and modify complex diagrams.
The contact module ships with a layout and shortcode for generating contact forms, which are designed to be compatible with mosts of form backends.
The announcement bar module makes important thing stand out, such as news and project’s releases.
When clicking any non-linkable image, the bigger picture module shows the original size of the the clicked image.
This module integrates the Hugo PWA module with HB, to customize the offline page and tweak some parameters.
As literally, this module sets the background image for pages.
The code block panel provides abilities to expand code, copy code, wrap code and toggle code line numbers.
A progress bar will be shown when opening a new page in the current tab and window.
The scrollbar module changes the default browser scrollbar style.
HB provides various of syntax highlighting modules, this article lists the supported styles.
AKA return to top, a button to back to top.
The noscript module display a alert message if the user browser doesn’t support JavaScript.
When the defaultContentLanguageInSubdir is enabled, Hugo will redirect the home page to the default language site, e.g. / -> /en/. This module will attempt to redirect the site based on the user’s preferred language.
The staticman comments module ships with flexible template for other modules, to generate comment form and show the nested comments.
This module display a content panel on single pages, which includes translations, comments and repo buttons.
This module ships with an universal pagination template, which allows configuring by parameters, such as alignment, size and the number of siblings.
The search module integrates HB with the Hugo Search Module, a powerful, flexible and responsive Hugo client side fuzzy search module.
The module implements a simple slide, the blog related posts module was built on top of it.
The socials module is a helper to generate social links.