Replies: 1 comment 7 replies
-
|
Thanks for suggesting. I agree, that a warning would be ideal, but since Material for MkDocs is a theme, we can't just add logic to the execution pipeline of MkDocs. We could create a "validation" plugin that would do this and maybe some other checks, but authors would always need to add the plugin explicitly, which kind of defeats its purpose. MkDocs should allow themes to add "please always run this" business logic. Maybe this functionality is something to raise to the maintainers of MkDocs? If there was such a functionality, we'd definitely implement it so authors have a better experience |
Beta Was this translation helpful? Give feedback.
-
|
Well, it's not a bug, it's a design decision. Documents should never contain more than one |
Beta Was this translation helpful? Give feedback.
-
|
I agree with you, except for this:
The theme could insert a warning as a In my humble opinion, this would be far better than the current behaviour. Having zero feedback to understand why nothing is displayed when there are several |
Beta Was this translation helpful? Give feedback.
-
|
By the way, the W3C validator totally validates a HTML document with 2 <!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<title>TEST</title>
</head>
<body>
<h1>Title 1</h1>
<h1>Title 2</h1>
</body>
</html> |
Beta Was this translation helpful? Give feedback.
-
|
This would be a warning to the user, not the author. It would not be possible to abort the build on this with
Absolutely agree. Again, if we could warn authors, we would. But exposing this to users is a no-no. Additionally, if you don't agree with our decision, you can always override the |
Beta Was this translation helpful? Give feedback.
-
|
Alright, as you wish. Thank you for your answers. |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Hi!
I recently had an issue where a documentation page showed zero Table of Contents,
when using this theme with Table of Contents enabled:
Page URL: https://py-pdf.github.io/fpdf2/Templates.html (it has now been fixed)
Page Markdown source at the time of the screenshot: https://github.com/py-pdf/fpdf2/blob/master/docs/Templates.md
This was the original heading structure:
I realized that the problem was due to the default toc-rendering settings set by theblog.structureplugin:https://github.com/squidfunk/mkdocs-material/blob/9.6.14/material/plugins/blog/structure/__init__.py#L306
I realized that the problem was due to the
toc.htmltemplate definition from this theme:https://github.com/squidfunk/mkdocs-material/blob/9.6.14/material/templates/partials/toc.html
My solution was to introduce a
check_toccustom plugin to ensure that all pages have only a singleh1heading:py-pdf/fpdf2#1457
Maybe at least a warning should be produced by the
blog.structureplugin when this situation arise,to inform the end-user why there is no Table of Contents displayed in the side bar?
Beta Was this translation helpful? Give feedback.
All reactions