You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Based on the documentation, it would be expected that the section index page is displayed with the title of the containing section as header (as on the docs screenshot), even if no title is specified for the section index page in mkdocs.yml (as in the docs code example).
However, the section index page will be displayed as Index unless the section name is re-specified, consistent with default behavior.
Using version 1.6.1 for mkdocs
Using version 9.5.49 for mkdocs-material
I'm not sure whether this is a bug or the documentation is misleading. I am assuming it's the latter, in which case I would propose adding a specific name to the example code to bring it in line with what is seen on the screenshot.
Thanks for reporting. Unfortunately, I'm having difficulties understanding what you're observing. We use section index pages in our documentation, and it does not display "Index", but uses the title of the section for the index.md page, e.g.:
Description
Based on the documentation, it would be expected that the section index page is displayed with the title of the containing section as header (as on the docs screenshot), even if no title is specified for the section index page in
mkdocs.yml
(as in the docs code example).However, the section index page will be displayed as
Index
unless the section name is re-specified, consistent with default behavior.Related links
Proposed change
I'm not sure whether this is a bug or the documentation is misleading. I am assuming it's the latter, in which case I would propose adding a specific name to the example code to bring it in line with what is seen on the screenshot.
Before submitting
The text was updated successfully, but these errors were encountered: