User Guide

Welcome to the HB (Hugo Bootstrap) framework, we’re excited that you’re interested in it.

In this section

• Getting Started

  Learn how to get started with HB.

  • Introduction
    HB (Hugo Bootstrap) is a modular framework that built on top of Hugo and Bootstrap v5.3.0+. HB is not a theme, it's used to build one.
  • Prerequisites
    HB is a feature-rich framework, but it also has a certain complexity. This article will detail the requirements for HB so that you can develop and use HB modules and themes properly.
  • Installation

    We provide a starter theme template for you to create a HB site quickly.

  • Install on Existing Sites

    This guide introduces how to install HB and modules to existing sites.

• Configuration
  • Configuration Structure

    This article will try to briefly introduce Hugo’s configuration structure.

  • Icons Configuration
    A simple guide about searching and using icons.
  • Menus Configuration

    This article describes the properties of the menu entry and how to config the menus.

  • Multilingual Configuration

    Previously, we had a rough understanding of Hugo’s configuration structure, and then we will introduce how to configure multilingual sites.

• Content
  • Creating Content

    Content is the most basic and core part of a site. This article will introduce some basic concepts of content and how to create it.

  • Markdown Syntax Guide
    Sample article showcasing basic Markdown syntax and formatting for HTML elements.
  • Shortcodes
    A list of various shortcodes.
  • Tables
    In this guide, you'll learn how to configure and create tables.
• Deployment
  • Deployment Overview

    This article introduces the key points of deployments.

  • Create Docker Images for Hugo Sites

    The article describes how to create a Docker image for Hugo site, then you’re able push it to container registry, and deploy on self-hosted server, Docker Swarm, k8s cluster and so on.

  • Deploy on Cloudflare Pages

    In this article, you’ll learn how to deploy your site on Cloudflare Pages.

  • Deploy on Netlify

    This article contains step-by-step instructions on how to deploy sites on Netlify.

  • Deploy Site on Github Pages

    This guide shows how to deploy your site on GitHub Pages via GitHub Actions.

• Advanced User Guide

  The advanced guide for theme’s users.

  • Add Custom HTML Markup

    You may want to include custom HTML markup to extend functionalities, that’s quit easy to do that with HugoPress built-in hooks and HB custom hooks.

  • Customize Scripts

    This article offers a sample for showing how to add custom scripts.

  • Customize Styles

    HB allows adding custom styles and overriding the Bootstrap default SCSS variables.

• Troubleshooting
  The list of known issues and corresponding solutions.
• Join Us

  We’re glad you plan to join us, and we appreciate any contributions. You can support this project in the following ways.

• Look and Feel
  • Enable Dark Mode Only
    It makes sense to remove the light and auto modes/themes and keep only the dark mode to suit your tastes.