Feature: Table of contents in blog articles

[mharrend]

One can activate a table of contents for blog articles if the word count gets larger than a specified parameter.

New parameters in config.toml:

• tocIfNecessary = true
• tocWordCount = 500 # Min. number of words in article after which toc gets generated

Additionally, one can deactivate the toc for single blog articles by adding tocActivated = false to the article config

Description

• Added toc.html file containing functionality to partials
• Updated content-single.html file to include toc functionality
• Added two parameters to config.toml file of exampleSite

Motivation and Context

The code is based on the toc partial example from the Hugo documentation: https://gohugo.io/content-management/toc/

The change allows an user to automatically add a table of contents to a blog article if the article is longer than a defined word count and the corresponding tocIfNecessary option is switched on.
In addition a user can deactivate the toc generation for specific blog articles by adding a tocActivated = false setting.

How Has This Been Tested?

Tested on my own setup:

• Tested with hugo server locally
• Tested via a deployment to Gitlab pages with subdomain.

Hugo Version: 0.30.2

Browser(s): Firefox, Chromium, Chrome

Screenshots (if appropriate):

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation, including theme.toml, accordingly.
• I have read the Contributing Document.

[pacollins]

I like the idea, but there are a couple things:

1. It needs to be styled to fit the theme a little better.
2. For some reason it renders as aside nav ul li ul li, which is giving the first item an extra bullet point.
3. The anchor links puts the heading behind the navbar. We need to figure out a way to fix this because it gives a disjunctive UX.
4. It also probably needs a heading on it such as Table of Contents otherwise its odd.

[pacollins]

Sorry for the delay, its finals week so I have been/will be super busy. Plan to address all PRs next Saturday.

Are you still planning to make these adjustments?