-
-
Notifications
You must be signed in to change notification settings - Fork 24
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
TOC Structure related issues #123
Comments
|
bittorala
pushed a commit
to bittorala/mkdocs-print-site-plugin
that referenced
this issue
Feb 20, 2025
When using deeply nested sections, the numbering of the headings started to get messy. See [GitHub issue](timvink#123). This commit revamps the TOC generation, both on the sidebar and the printed page, to always navigate the sections recursively and provide a predictable, simple, "classic" (as per [this comment](timvink#115 (comment))) numbering scheme. This commit also works on and expands the scope of [this PR](timvink#115), as it has been frozen for quite some time, and its scope was slightly more limited.
bittorala
pushed a commit
to bittorala/mkdocs-print-site-plugin
that referenced
this issue
Feb 20, 2025
When using deeply nested sections, the numbering of the headings started to get messy. See [GitHub issue](timvink#123). This commit revamps the TOC generation, both on the sidebar and the printed page, to always navigate the sections recursively and provide a predictable, simple, "classic" (as per [this comment](timvink#115 (comment))) numbering scheme. This commit also works on and expands the scope of [this PR](timvink#115), as it has been frozen for quite some time, and its scope was slightly more limited.
bittorala
pushed a commit
to bittorala/mkdocs-print-site-plugin
that referenced
this issue
Feb 20, 2025
When using deeply nested sections, the numbering of the headings started to get messy. See [GitHub issue](timvink#123). This commit revamps the TOC generation, both on the sidebar and the printed page, to always navigate the sections recursively and provide a predictable, simple, "classic" (as per [this comment](timvink#115 (comment))) numbering scheme. This commit also works on and expands the scope of [this PR](timvink#115), as it has been frozen for quite some time, and its scope was slightly more limited.
bittorala
pushed a commit
to bittorala/mkdocs-print-site-plugin
that referenced
this issue
Feb 20, 2025
When using deeply nested sections, the numbering of the headings started to get messy. See [GitHub issue](timvink#123). This commit revamps the TOC generation, both on the sidebar and the printed page, to always navigate the sections recursively and provide a predictable, simple, "classic" (as per [this comment](timvink#115 (comment))) numbering scheme. This commit also works on and expands the scope of [this PR](timvink#115), as it has been frozen for quite some time, and its scope was slightly more limited. Besides, total line count has been greatly reduced, and some aspects of the code have been simplified. Note, however, that here we have opted to leave the inner headings outside the TOC of the printed document, thus keeping it consistent with the sidebar TOC, but this is different from the original approach. It could be changed in future commits.
bittorala
pushed a commit
to bittorala/mkdocs-print-site-plugin
that referenced
this issue
Feb 20, 2025
When using deeply nested sections, the numbering of the headings started to get messy. See [GitHub issue](timvink#123). This commit revamps the TOC generation, both on the sidebar and the printed page, to always navigate the sections recursively and provide a predictable, simple, "classic" (as per [this comment](timvink#115 (comment))) numbering scheme. This commit also works on and expands the scope of [this PR](timvink#115), as it has been frozen for quite some time, and its scope was slightly more limited. Besides, total line count has been greatly reduced, and some aspects of the code have been simplified. Note, however, that here we have opted to leave the inner headings outside the TOC of the printed document, thus keeping it consistent with the sidebar TOC, but this is different from the original approach. It could be changed in future commits.
bittorala
pushed a commit
to bittorala/mkdocs-print-site-plugin
that referenced
this issue
Feb 20, 2025
When using deeply nested sections, the numbering of the headings started to get messy. See [GitHub issue](timvink#123). This commit revamps the TOC generation, both on the sidebar and the printed page, to always navigate the sections recursively and provide a predictable, simple, "classic" (as per [this comment](timvink#115 (comment))) numbering scheme. This commit also works on and expands the scope of [this PR](timvink#115), as it has been frozen for quite some time, and its scope was slightly more limited. Besides, total line count has been greatly reduced, and some aspects of the code have been simplified. Note, however, that here we have opted to leave the inner headings outside the TOC of the printed document, thus keeping it consistent with the sidebar TOC, but this is different from the original approach. It could be changed in future commits.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Hi @timvink
We have an extensive set of documentation with various hierarchical levels.. Please review the following concerns and provide your suggestions.
Issues with Table of Contents (TOC):
TOC Depth Not Displaying Properly: I have set the TOC depth to 6, but it only displays the up to level 2 in TOC. What level does the TOC actually consider when generating the output?
Inconsistent Numbering in TOC: The TOC numbering seems bit weird, using a mix of Roman numerals and regular numbers. For example: in your print preview:

Proposed Numbering Structure: To simplify and make the structure clearer, the numbering should follow the logical hierarchy. As sections drill down, they should follow the main section number. For instance:
If there are additional sub-sections under “3.1 Export to PDF,” they should be numbered like this:
Similarly, under “4 Demo Content,” sub-sections should be numbered "4.1", "4.2", etc.
HTML Tags Related Issue:
Additionally, image references using HTML tags are not displaying properly and show an image error. For example:
Could you help resolve these issues?
The text was updated successfully, but these errors were encountered: