Fixed bug with the index page's relative links. #2077
Draft
Conversation
This file contains 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
HU90m
force-pushed
the
landing-page-links-fix
branch
from
af67890
to
947d6b4
Compare
KFearsoff
approved these changes
Dec 6, 2023
|
@rustbot label -S-waiting-on-review |
If there is no index page in the source directory, mdbook uses the first chapter as the index page. When doing so, mdbook doesn't render the page any differently. This causes relative links on the page to break, if the first chapter is within a sub-directory. To fix this, a redirect to the first chapter is used instead of the copy of the page.
HU90m
force-pushed
the
landing-page-links-fix
branch
from
947d6b4
to
c667905
Compare
nbdd0121
reviewed
Feb 1, 2024
Comment on lines
-123
to
-138
| if ctx.is_index { | ||
| ctx.data.insert("path".to_owned(), json!("index.md")); | ||
| ctx.data.insert("path_to_root".to_owned(), json!("")); | ||
| ctx.data.insert("is_index".to_owned(), json!(true)); | ||
| let rendered_index = ctx.handlebars.render("index", &ctx.data)?; | ||
| let rendered_index = self.post_process( | ||
| rendered_index, | ||
| &ctx.html_config.playground, | ||
| &ctx.html_config.code, | ||
| ctx.edition, | ||
| ); | ||
| debug!("Creating index.html from {}", ctx_path); | ||
| utils::fs::write_file(&ctx.destination, "index.html", rendered_index.as_bytes())?; | ||
| } | ||
|
|
||
| Ok(()) |
There was a problem hiding this comment.
Could the redirection code be moved here, so we can avoid returning the URL and changing the is_index logic?
|
Not sure why the tag is removed... @rustbot label +S-waiting-on-review |
HU90m
commented
Feb 2, 2024
Comment on lines
+545
to
+546
| let redirect_to = first_file | ||
| .to_str() |
There was a problem hiding this comment.
Changing PR to draft because this implementation is buggy and shouldn't be merged. Simply converting path to string can produce bad URLs.
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.
If there is no index page in the source directory, mdbook uses the first chapter as the index page. When doing so, mdbook doesn't render the page any differently. This causes relative links on the page to break, if the first chapter is within a sub-directory and there is not
index.md(orREADME.md) in the root.To fix this, a redirect to the first chapter is used instead of a copy of the page.
See bug report for more information: #2060