TOC rendering issue

[majkinetor]

TOC part with sections is rendered totally differently from the other TOC elements.

Take a look at "Extra" in the TOC here:

• https://majkinetor.github.io/mm-docs-template/docs.pdf#page=2

Here are the problems:

1. It can't be clicked
2. It has quote line in it ?
3. It is separated from other TOC elements.

All in all, it looks very ugly, especially with more of them.

[timvink]

Yes, definitely a bug with the section headings. I'll look into it.

Just a quite check, because I couldn't find it, are you using the latest version of this plugin?

Also, which version of mkdocs-material are you using (v8 just came out, might be related) ?

[majkinetor]

Yeah, all latest.

FYI, I am always using the same demo project to show you to the problems. Its base on mm-docs and you can see all versions in requirements.txt

[majkinetor]

(v8 just came out, might be related) ?

No, this happens since first version of this plugin.

[timvink]

So the root cause is that in your project, the first page under the new 'Extra' section (vars.md) does not start with a level 1 heading:

https://github.com/majkinetor/mm-docs-template/blob/02d7823bf339f2f91a7849911fdae8172b7bbe33/source/docs/vars.md?plain=1#L6

This plugin has quite some logic to support sections, even nested sections, like the one in the screenshot below.

Things got super complex if a new page does not start with a new level 1 heading and so I required all pages to start with heading 1. That is also your solution:

The real problem is that this error wasn't raised:

mkdocs-print-site-plugin/mkdocs_print_site_plugin/plugin.py

Lines 179 to 188 in ad73023

	# We need to validate that the first heading on each page is a h1
	# This is required for the print page table of contents and enumeration logic
	if self.config.get("add_table_of_contents") or self.config.get("enumerate_headings"):
	if page in self.all_pages_in_nav:
	match = re.search(r"\<h[0-6]", html)
	if match:
	if not match.group() == "<h1":
	msg = f"The page {page.title} ({page.file.src_path}) does not start with a level 1 heading."
	msg += "This is required for print page Table of Contents and/or enumeration of headings."
	raise AssertionError(msg)

I tracked down & fixed that bug, will release a new version soon.

[timvink]

Should be fixed in v2.1 let me know :)

[majkinetor]

It works:

ERROR - Error reading page 'vars.md': The page Variables (vars.md) does not start with a level 1 heading.This is required for print page Table of Contents and/or enumeration of headings.

Adding it looks good.

Thanks a lot :)