add Index Files section in Pretty URLs recipe #101
Merged
Conversation
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
i think this is a natural place to put it, because both index files and fallback extensions are concerned with resolving shortened forms of URLs. it would also be a bit short if placed on its own page. happy to take on any editing feedback.
mre
reviewed
Sep 13, 2025
Member
mre
left a comment
mre
left a comment
There was a problem hiding this comment.
Great writing, as always. Just added a few remarks.
Comment on lines
16
to
21
| :::note[Good to know] | ||
| In Lychee, pretty URLs only need special handling in _local_ files. When | ||
| checking links in online webpages, we can rely on the web server to resolve | ||
| pretty links to the right destination. For local files, Lychee must | ||
| handle this process itself. | ||
| ::: |
| that do not end in the file extension `.html` but that are still resolving to the | ||
| files with that file extension. | ||
| In the modern web, URLs are often made "pretty" in a number of ways. This makes | ||
| them more concise and memorable, but these links can cause problems for Lychee |
Member
There was a problem hiding this comment.
lychee is normally written in all lowercase, even if it starts a sentence. 😉
Suggested change
| them more concise and memorable, but these links can cause problems for Lychee | |
| them more concise and memorable, but these links can cause problems for lychee |
katrinafyi
changed the title
Co-authored-by: Matthias Endler <[email protected]>
…iles)" and fix formatting
Member
Author
|
review comments should be fixed now. i've also done two more things which deserve scrutiny.
|
Member
|
Yes, I think it looked and read well, so I went ahead and merged it. Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
i think this is a natural place to put it, because both index files and fallback extensions are concerned with resolving shortened forms of URLs. it would also be a bit short if placed on its own page. combining them also makes it easy for me to add a note about their interaction.
happy to take on any editing feedback.
related to lycheeverse/lychee#1777