Use README.md as index.html also if use_directory_urls is false#2081
Merged
waylan merged 3 commits intomkdocs:masterfrom Apr 26, 2020
Merged
Use README.md as index.html also if use_directory_urls is false#2081waylan merged 3 commits intomkdocs:masterfrom
waylan merged 3 commits intomkdocs:masterfrom
Conversation
This comment was marked as abuse.
This comment was marked as abuse.
Contributor
|
I just searched through the old discussions about this and can't find any reason for the current behavior of only working when |
Contributor
|
One thing is missing. We need a note added to the release notes. Here: mkdocs/docs/about/release-notes.md Lines 24 to 33 in 3bada39 |
This comment was marked as abuse.
This comment was marked as abuse.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Right now, just like any foo/index.md, any foo/README.md becomes foo/index.html, but that works only if
use_directory_urlsis on.But the
use_directory_urlsfeature is for changing foo/bar.md into foo/bar/index.html and should not prevent the former from working.I'm hoping that this is more of an oversight (due to the source code for the two things being very related) than an intentional exclusion.
So I'm sending a small pull request to fix that and also unify the code paths. But feel free to discuss this as an issue in case it's not as agreeable as I thought.