Table of contents (TOC) not generating anchor hyperlinks for <h2> tags, only ##-style headings

[abevoelker]

Environment

• Minimal Mistakes version: 4.21.0
• Ruby gem or remote theme version: Ruby gem minimal-mistakes-jekyll version 4.21.0
• Jekyll version: 3.8.7
• Git repository URL: https://github.com/mmistakes/minimal-mistakes
• GitHub Pages hosted (if yes provide URL to site): https://mmistakes.github.io/minimal-mistakes/docs/helpers
• Operating system: Ubuntu 18.04

Expected behavior

I expect setting toc: true in the page front matter and then including HTML header markup in my .md files like

<h2>Foo</h2>

to generate working anchor tags in the table of content (toc) sidebar, the same way it works for using markdown shorthand like

## Foo

Steps to reproduce the behavior

If you visit https://mmistakes.github.io/minimal-mistakes/docs/helpers/ right now you can see this happening in the toc there; the Placeholder 1, Placeholder 2, Placeholder 3 text in the toc are not hyperlinks but just plain text. Here is a screenshot:

I can reproduce the behavior on my own Jekyll site by writing headers like <h2>Placeholder 1</h2>. Writing ## Placeholder 1 instead generates the anchor link successfully.

Other

N/A

[iBug]

I would rather say this is the correct behavior. The ToC template expects headings to have an HTML id attribute, which Jekyll's default Markdown renderer, Kramdown, will automatically generate with auto_ids enabled.

If you want manually-written HTML headings to have ToC entries, create your id as well:

<h2 id="placeholder-1">Placeholder 1</h2>

[abevoelker]

Sounds good, I can work with that, thank you.

I'm not sure what was different with the theme in April but the documentation did not have this issue then: https://web.archive.org/web/20200415005555/https://mmistakes.github.io/minimal-mistakes/docs/helpers/

It seems the gem version at that time would've been 4.19.1, but checking out that version locally and generating the docs still has the behavior I noticed in the current version.

Anyway my issue is resolved so thanks again.

[iBug]

Hi, please check out #2752 for my analysis of the current behavior and the old (April 2020) behavior. This will be fixed in the next release of the theme.

[abevoelker]

Looks great! Thanks for your help and thoroughness. 🎉