-
Notifications
You must be signed in to change notification settings - Fork 10.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore(docs): Pre-encoded unicode characters can't be used in paths #36325
Merged
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
…e characters can't be used in paths
gatsbot
bot
added
the
status: triage needed
Issue or pull request that need to be triaged and assigned to a reviewer
label
Aug 4, 2022
…de paths should not be encoded
marvinjude
added
type: documentation
An issue or pull request for improving or updating Gatsby's documentation
and removed
status: triage needed
Issue or pull request that need to be triaged and assigned to a reviewer
labels
Aug 5, 2022
LekoArts
changed the title
docs(gatsby): Update Routing docs to reflect that pre-encoded unicode characters can't be used in paths
chore(docs): Pre-encoded unicode characters can't be used in paths
Aug 9, 2022
LekoArts
approved these changes
Aug 9, 2022
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
This was referenced Aug 16, 2022
This was referenced Aug 16, 2022
This was referenced Aug 16, 2022
This was referenced Dec 26, 2022
This was referenced Nov 27, 2023
This was referenced Nov 27, 2023
This was referenced Nov 29, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
type: documentation
An issue or pull request for improving or updating Gatsby's documentation
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.
Description
I ran into this weird behavior when creating a multilingual site where the paths were coming pre-encoded from the CMS. I was expecting that Gatsby would recognise pre-encoded paths and make the necessary adjustments so that I wouldn't have to handle anything in
gatsby-node
but I later found that paths MUST be encoded or pages break and bad things happen :oI think this could be changed internally so that we don't have to rely on the developer to pass the correct value and instead handle the encoding inside Gatsby. For the meantime however, a docs update should suffice so that developers don't have to dig into the internals to understand whether or not unicode is supported and how to use it.
TLDR; Made a few changes to the API docs to mention how paths should not be encoded when containing unicode characters.
Documentation
path
field description increatePage
APIRelated Issues
Related to #16765