Default Theme - External Link Regex: Allow for System Deep Links #1677
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.
Summary
Allow users to have links that open system applications (i.e. deep links).
What kind of change does this PR introduce? (check at least one)
If changing the UI of default theme, please provide the before/after screenshot:
Does this PR introduce a breaking change? (check one)
If yes, please describe the impact and migration path for existing applications:
The PR fulfills these requirements:
fix #xxx[,#xxx]
, where "xxx" is the issue number)You have tested in the following browsers: (Providing a detailed version will be better.)
If adding a new feature, the PR's description includes:
To avoid wasting your time, it's best to open a feature request issue first and wait for approval before working on it.
Other information:
My company is using Vuepress for an internal documentation site. We would like to be able to use deep links to open our bug tracking app so other internal teams can help improve our documentation (most employee's won't have access to the enterprise Github and the repo is restricted). The current default-theme external link regex doesn't take into account these types of links for navbar links or for editLinks with our deep link in place of a normal docRepo link in themeConfig and fails to open them correctly (unless done manually with in markdown
<a>
tags inside the pages themselves). I found the Apple documentation here that best describes what we're trying to do. If you have any questions please reach out and hopefully I can answer them!We're huge fans of what y'all do! Thank you for your time and consideration 👋