-
-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Closed
Description
According to the docs, Writing-your-docs:Index-pages, README.md will render into index.html. There is no mention of readme.md. The implementation reflects this behavior:
mkdocs/mkdocs/structure/files.py
Line 151 in dc35569
| return 'index' if stem in ('index', 'README') else stem |
But the check in get_files() ignores casing:
mkdocs/mkdocs/structure/files.py
Lines 246 to 247 in dc35569
| if filename.lower() == 'readme.md' and 'index.md' in filenames: | |
| log.warning(f"Both index.md and readme.md found. Skipping readme.md from {source_dir}") |
I believe it should be:
if filename == 'README.md' and 'index.md' in filenames:
log.warning(f"Both index.md and README.md found. Skipping README.md from {source_dir}")Metadata
Metadata
Assignees
Labels
No labels