Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2025-09-10 17:53:36 +02:00
Code Issues Projects Releases Wiki Activity

docs: don't rewrite absolute doc links

Browse Source
This commit is contained in:
Thomas Heartman 2023-01-06 09:11:47 +01:00
parent be9cad8a61
commit 3fce0c4090
No known key found for this signature in database
GPG Key ID: 47CFBB2D87C87664
1 changed files with 7 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
website/readme-fns.js
View File

@ -59,14 +59,17 @@ const documentUrls = Object.entries(SDKS).map(
// Replace links in the incoming readme content.
//
// There's two cases we want to handle:
// There's one cases we want to handle:
//
// 1. Relative links that point to the repo. These must be prefixed with the
// link to the github repo.
//
// 2. Absolute links to docs.getunleash.io. While absolute links will work, they
// trigger full page refreshes. If we can make them relative links instead, then
// we'll get a slightly smoother user experience.
// Note: You might be tempted to handle absolute links to docs.getunleash.io and
// make them relative. While absolute links will work, they trigger full page
// refreshes. Relative links give a slightly smoother user experience.
//
// However, if the old link goes to a redirect, then the client-side redirect
// will not kick in, so you'll end up with a "Page not found".
const replaceLinks = ({ content, repo }) => {
const markdownLink = /(?<=\[.*\]\(\s?)(\S+)(?=.*\))/g;
@ -76,13 +79,6 @@ const replaceLinks = ({ content, repo }) => {
// https://developer.mozilla.org/en-US/docs/Web/API/URL/URL
const parsedUrl = new URL(url);
// case 2:
if (parsedUrl.hostname === 'docs.getunleash.io') {
return `${parsedUrl.pathname ?? '/'}${parsedUrl.query ?? ''}${
parsedUrl.hash ?? ''
}`;
}
return url;
} catch {
// case 1