docs: set trailingSlash: false to fix refresh issues on GitHub pages
#14
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
Signed-off-by: Haoqun Jiang <haoqunjiang@gmail.com> It's said (and as I tested) that if GitHub Pages detects the URL points to a directory on the server, it would add a trailing slash to the URL on refreshing. <https://stackoverflow.com/a/33271505/2302258> Per [Docusaurus's default configuration](https://docusaurus.io/docs/api/docusaurus-config#trailingSlash), `docs/getting-started/overview.mdx` would emit `docs/getting-started/overview/index.html`, therefore GitHub Pages would take `docs/getting-started/overview/` as the canonical URL. But the relative links in the document would not be touched by default, so `./alternatives` remains `./alternatives`, which is `docs/getting-started/alternatives` in the original web page, and `docs/getting-started/overview/alternatives` after refreshing. The latter would be a 404 page. To fix this, we have to enforce a `trailingSlash` style. `trailingSlash: true` requires fixing quite a few links across the docs, so I chose `trailingSlash: false` to keep as many links untouched as possible.
tchetwin
force-pushed
the
docs-trailing-slash-off-for-github-pages
branch
from
65b585e to
d9702f6
Compare
molisani
approved these changes
Oct 10, 2024
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.
Issue number of the reported bug or feature request: #13
Describe your changes
It's said (and as I tested) that if GitHub Pages detects that the URL points to a directory on the server, it will add a trailing slash to the URL when refreshing.
https://stackoverflow.com/a/33271505/2302258
Per Docusaurus's default configuration,
docs/getting-started/overview.mdxwould emitdocs/getting-started/overview/index.html, therefore GitHub Pages would takedocs/getting-started/overview/as the canonical URL.However, the relative links in the document are not touched by default, so
./alternativesremains./alternatives, which isdocs/getting-started/alternativeson the original web page, anddocs/getting-started/overview/alternativesafter refreshing. The latter would lead to a 404 page.To fix this, we have to enforce a
trailingSlashstyle.trailingSlash: truerequires fixing quite a few links across the docs, so I chosetrailingSlash: falseto keep as many links untouched as possible.