mumble-voip/mumble-www

Content headline levels break toc link list

Closed this issue · 4 comments

Is (markdown) content supposed to use level 1 or level 2 headings?

Only one h1 should exist. Which is used for the page title (and website header title).

Consequently, it should be h2s, right?

But that breaks the toc links because the list starts at level 2:

image

Upstream hugo docs does start md content with second level headlines (example)

So h2 breaks the TOC but that's what they use in their own docs? Does this mean our hugo configuration is broken somehow? 🤔

I do think the VS linter changed at some point from self-contained markdown docs that would expect a single level 1 headline to allowing multiple, because it makes sense in hugo which I thought I saw with this transition would convert it to level two headlines while the h1 is still fed from the baseof template.

Seeing the above I wonder if there is some logic in the parsing or not, something template specific, or what. Maybe I just remember something wrong or had a wrong conclusion about something in the past.

Still needs a more specific checking of it. How headline levels are handled for md content.

Not sure how or why or when this changed and fixed, but our Contribute page as well as the 1.3.0 release blog post which the screenshot is from have ToC which are fine (not as in the screenshot). I probably fixed this when introducing ToC for content pages (Contribute).