search

mkdocs / mkdocs

Project documentation with Markdown.
https://www.mkdocs.org
BSD 2-Clause "Simplified" License
18.66k stars 2.38k forks source link

Make index_page configurable #3152

Closed noelmcloughlin closed 2 months ago

noelmcloughlin commented 1 year ago

I would like index_page: <readme-or-some-other-name>.md feature. While https://github.com/mkdocs/mkdocs/issues/608 is concerned with readme.md I see different problem. Index is a semantic concept in various ontologys and also wikidata KG (here, here, here).

The LinkML (life sciences mainly) community model concepts in schemas for various domains. Today I was modeling index slot/propety and mkdocs generates two index.md and second overwrites first. Since the slot/property index is entrenched in various ontologies - using another name is not possible.

Please add flexibility for index.md to support semantic use cases, where "index" is a thing outside mkdocs project.

tomchristie commented 2 months ago

I'm going to push this into a discussion, rather than an issue for now.

Perhaps you could expand on exactly what behavior you're asking for here. We use index.md because it maps to index.html which is what webservers expect.