Bitsandpieces Theme Documentation

Installation

Download the theme to your Hugo projects' themes/ directory.

Use the provided config.toml or base your current one on the example.

That's it, enjoy! Further configuration is below if that's of your interest.

Example config.toml

This is the config.toml that I use for my website.

baseURL = "/"
languageCode = "en-us"
title = "Colin Murphy's site"
theme = "bitsandpieces"
disableKinds = ["taxonomy", "taxonomyTerm"]

[[menu.main]]
    name = "Home"
    url = "/"
    weight = 1
    identifier = "alt+h"

[permalinks]
    notes = "/notes/:title/"

[params]
    showTitle = true
    showSideNav = false
    mainPosts = true

Keyboard shortcuts

This theme supports keyboard shortcuts for navigation entries. These are useful for your most commonly used pages, such as the homepage.

To use this, simply add identifier with your keyboard shortcut. For example, alt + h will be entered in as alt+h.

Here are 2 examples, with one using config.toml and the other in the toml frontmatter:

config.toml

[[menu.main]]
    name = "Home"
    url = "/"
    weight = 1
    identifier = "alt+h"

Markdown frontmatter

---
title: "Home"
menu:
main:
    weight: 1
    identifier: "alt+h"
---

Other parameters

Param Type Description
showTitle BOOL When true, the website title will be shown above the navigation.
showSideNav BOOL When true the side navigation (for navigating through the current page) will be shown on the right.
mainPosts BOOL When true, the homepage will display a list of blog posts.
mainFolder TEXT Specify your blog folder here. If you keep your posts in posts/ type in posts here.

Credits

This theme is based off of the bitsandpieces theme by lostkeys on GitHub.

It also utilizes the following projects: