Skip to content
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

Section index page naming unclear #7914

Open
2 tasks done
hosmanadam opened this issue Jan 17, 2025 · 1 comment
Open
2 tasks done

Section index page naming unclear #7914

hosmanadam opened this issue Jan 17, 2025 · 1 comment
Labels
documentation Issue concerns the documentation needs input Issue needs further input by the reporter

Comments

@hosmanadam
Copy link

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.

Using version 1.6.1 for mkdocs
Using version 9.5.49 for mkdocs-material

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

@hosmanadam hosmanadam added the documentation Issue concerns the documentation label Jan 17, 2025
@squidfunk
Copy link
Owner

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.:

mkdocs-material/mkdocs.yml

Lines 228 to 229 in 45f60a6

- Extensions:
- setup/extensions/index.md

Image

Could you please provide a minimal reproduction that demonstrates your observation?

@squidfunk squidfunk added the needs input Issue needs further input by the reporter label Jan 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issue concerns the documentation needs input Issue needs further input by the reporter
Projects
None yet
Development

No branches or pull requests

2 participants