-
-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Description
I have a use case having a README.md and an index.md file on my docs folder.
- The readme files content is repository specific and is the documentation that we want to show on github.
- The index file is the project documentation homepage.
I tried to to define this on my mkdocs.yml:
nav:
- Introduction: index.md
- Other: "other/index.md"
- Repo Readme: "README.md"I get that readme file is not considered as index if a index.md file is present, but why not allow still access to that file if we want to add that reference?
UPDATE
current vs expected behaviour
Current:
Add a file index.md to docs. A file index.html gets created in the site. The nav link leads there.
Add a file README.md to docs. A file index.html gets created in the site. The nav link leads there.
Add a file index.md to docs. Add a file README.md to docs. A file index.html gets created in the site. using the index.md file. The nav link leads there. the README.md file is ignored completely showing a warning about it
Expected
Add a file index.md to docs. A file index.html gets created in the site. The nav link leads there. (same)
Add a file README.md to docs. A file index.html gets created in the site. The nav link leads there. (same)
Add a file index.md to docs. Add a file README.md to docs. A file index.html gets created in the site. using the index.md file. The nav link leads there. a Readme.html file is created using the README.md file