-
Notifications
You must be signed in to change notification settings - Fork 923
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
feat: add route option (close #1505) #1538
Open
Mister-Hope
wants to merge
24
commits into
main
Choose a base branch
from
route-option
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
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
Mister-Hope
force-pushed
the
route-option
branch
from
April 17, 2024 05:21
ab871fa
to
f05b2e9
Compare
meteorlxy
changed the title
feat: add route option
feat: add route option (close #1505)
May 14, 2024
Pull Request Test Coverage Report for Build 9219541970Details
💛 - Coveralls |
pengzhanbo
approved these changes
May 22, 2024
now e2e test is added in this PR |
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.
Warning
This PR is now based on #1562, so it's expected #1562 to be merged first.
Tip
For a file like
/a/b.md
, the full format is/a/b.html
and clean format is/a/b
Features
This pr adds
route
option for vuepress config file.route.cleanUrl
option to support the "clean format"pagePatterns
andpermalinkPatten
is moved toroute.pagePatterns
androute.permalinkPatten
Bug Fixes
Previously, when use manually set a permalink or page path to a clean format like
/a
, they will always get 404 when trying to visit the page (in any link format). Now, this is correctly handled. Page path will be normalized to a "full" or "clean" version based oncleanUrl
, no matter user use "clean", "full" format or mixing them.Performance Improvements
Now, the key in routes is always the clean format, which avoid outputting uncessary
.html
suffix for most pages.Potential Breaking Changes
inferRoutePath
andnormalizeRoutePath
return the "clean" format instead of "full" format.Tweaks
Now a new field called routeKey is on the
Page
object.