Logo

Hugo Catalog

Installation

Prerequisites

Installing Hugo Catalog is very easy, simply run the following command inside your themes folder:

git clone [email protected]:benmarte/hugo-catalog.git && rm -rf ./hugo-catalog/.git

Or simply download the theme and place it in your hugo theme directory.

How to customize and configure Hugo Catalog

In order to customize your Hugo Catalog instance you need to copy the following code to your sites config.toml file:

theme = 'hugo-catalog'

[markup.goldmark.parser.attribute]
block = true
title = true

[Params]
    # the path to your site logo
    logo = '/images/hugo-catalog-icon.svg'
    # enables displaying the site name in the header
    disable_site_name_header = false
    # sets the sites primary color
    primary_color = "#003b5c"
    # sets the sites secondary color
    secondary_color = "#C6007E"
    # sets the sites font family
    font_family = "Montserrat"
    # enables subnav page links in nav
    enable_subnav = false

[module]
  [module.hugoVersion]
    extended = true

Variable Type: string

The path to your site logo can be a relative to the site or an image hosted on a CDN.

Default hugo catalog logo

this is a test description

Default hugo catalog text logo

If you delete or comment out this value in your config.toml the sites title will be displayed as text in place of the logo.

disable_site_name_header

Variable Type: boolean (true/false)

This controls the display of the site name above the header of the site.

If you set this value to true you will disable displaying the site name in the header, if you add a subtitle property to your pages front matter it will display regardless of this settings value.

primary_color

Variable Type: string

Sets the primary color of the site, this color applies to the sites header, and main links color. If this value is not set the site will use the default fallback value: #003b5c

primary_color

HEX: #003b5c

secondary_color

Variable Type: string

Sets the secondary color of the site, this color applies to hover states of links in the content area and the sub-nav items on the navigation menu. If this value is not set the site will use the default fallback value: #C9177E

secondary_color

HEX: #C9177E

font_family

Variable Type: string

Sets the font family for the site, if this value is not set the site will use the default fallback font-family value: Montserrat

You can change the font to any google font, just change this value to the font name from google.

enable_subnav

Variable Type: boolean (true/false)

This setting controls if the pages table of contents gets rendered as sub nav items for the page being displayed.

enable_subnav = true

enable_subnav = false