3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-22 21:47:01 +02:00
Code Issues Projects Releases Packages Wiki Activity

feat(plugin-client-redirects): keep the query string + hash (#8227)

Browse source 
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
This commit is contained in:
Xabier Lahuerta Vazquez 2022-10-20 18:01:18 +02:00 • committed by GitHub
parent 7b3ebb7729
commit 5ddcbf47a8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 16 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

4
packages/docusaurus-plugin-client-redirects/src/__tests__/__snapshots__/createRedirectPageContent.test.ts.snap
View file

@ -9,7 +9,7 @@ exports[`createRedirectPageContent encodes uri special chars 1`] = `
<link rel="canonical" href="https://docusaurus.io/gr/%CF%83%CE%B5%CE%BB%CE%B9%CE%B4%CE%B1%CF%82/" /> <link rel="canonical" href="https://docusaurus.io/gr/%CF%83%CE%B5%CE%BB%CE%B9%CE%B4%CE%B1%CF%82/" />
</head> </head>
<script> <script>
window.location.href = 'https://docusaurus.io/gr/%CF%83%CE%B5%CE%BB%CE%B9%CE%B4%CE%B1%CF%82/'; window.location.href = 'https://docusaurus.io/gr/%CF%83%CE%B5%CE%BB%CE%B9%CE%B4%CE%B1%CF%82/' + window.location.search + window.location.hash;
</script> </script>
</html>" </html>"
`; `;
@ -23,7 +23,7 @@ exports[`createRedirectPageContent works 1`] = `
<link rel="canonical" href="https://docusaurus.io/" /> <link rel="canonical" href="https://docusaurus.io/" />
</head> </head>
<script> <script>
window.location.href = 'https://docusaurus.io/'; window.location.href = 'https://docusaurus.io/' + window.location.search + window.location.hash;
</script> </script>
</html>" </html>"
`; `;

22
packages/docusaurus-plugin-client-redirects/src/__tests__/__snapshots__/writeRedirectFiles.test.ts.snap
View file

@ -10,7 +10,7 @@ exports[`toRedirectFiles creates appropriate metadata for empty baseUrl: fileCon
<link rel="canonical" href="/abc" /> <link rel="canonical" href="/abc" />
</head> </head>
<script> <script>
window.location.href = '/abc'; window.location.href = '/abc' + window.location.search + window.location.hash;
</script> </script>
</html>", </html>",
] ]
@ -26,7 +26,7 @@ exports[`toRedirectFiles creates appropriate metadata for root baseUrl: fileCont
<link rel="canonical" href="/abc" /> <link rel="canonical" href="/abc" />
</head> </head>
<script> <script>
window.location.href = '/abc'; window.location.href = '/abc' + window.location.search + window.location.hash;
</script> </script>
</html>", </html>",
] ]
@ -42,7 +42,7 @@ exports[`toRedirectFiles creates appropriate metadata trailingSlash=false: fileC
<link rel="canonical" href="https://docusaurus.io/abc" /> <link rel="canonical" href="https://docusaurus.io/abc" />
</head> </head>
<script> <script>
window.location.href = 'https://docusaurus.io/abc'; window.location.href = 'https://docusaurus.io/abc' + window.location.search + window.location.hash;
</script> </script>
</html>", </html>",
"<!DOCTYPE html> "<!DOCTYPE html>
@ -53,7 +53,7 @@ exports[`toRedirectFiles creates appropriate metadata trailingSlash=false: fileC
<link rel="canonical" href="https://docusaurus.io/def.html" /> <link rel="canonical" href="https://docusaurus.io/def.html" />
</head> </head>
<script> <script>
window.location.href = 'https://docusaurus.io/def.html'; window.location.href = 'https://docusaurus.io/def.html' + window.location.search + window.location.hash;
</script> </script>
</html>", </html>",
"<!DOCTYPE html> "<!DOCTYPE html>
@ -64,7 +64,7 @@ exports[`toRedirectFiles creates appropriate metadata trailingSlash=false: fileC
<link rel="canonical" href="https://docusaurus.io/" /> <link rel="canonical" href="https://docusaurus.io/" />
</head> </head>
<script> <script>
window.location.href = 'https://docusaurus.io/'; window.location.href = 'https://docusaurus.io/' + window.location.search + window.location.hash;
</script> </script>
</html>", </html>",
] ]
@ -80,7 +80,7 @@ exports[`toRedirectFiles creates appropriate metadata trailingSlash=true: fileCo
<link rel="canonical" href="https://docusaurus.io/abc" /> <link rel="canonical" href="https://docusaurus.io/abc" />
</head> </head>
<script> <script>
window.location.href = 'https://docusaurus.io/abc'; window.location.href = 'https://docusaurus.io/abc' + window.location.search + window.location.hash;
</script> </script>
</html>", </html>",
"<!DOCTYPE html> "<!DOCTYPE html>
@ -91,7 +91,7 @@ exports[`toRedirectFiles creates appropriate metadata trailingSlash=true: fileCo
<link rel="canonical" href="https://docusaurus.io/def.html" /> <link rel="canonical" href="https://docusaurus.io/def.html" />
</head> </head>
<script> <script>
window.location.href = 'https://docusaurus.io/def.html'; window.location.href = 'https://docusaurus.io/def.html' + window.location.search + window.location.hash;
</script> </script>
</html>", </html>",
"<!DOCTYPE html> "<!DOCTYPE html>
@ -102,7 +102,7 @@ exports[`toRedirectFiles creates appropriate metadata trailingSlash=true: fileCo
<link rel="canonical" href="https://docusaurus.io/" /> <link rel="canonical" href="https://docusaurus.io/" />
</head> </head>
<script> <script>
window.location.href = 'https://docusaurus.io/'; window.location.href = 'https://docusaurus.io/' + window.location.search + window.location.hash;
</script> </script>
</html>", </html>",
] ]
@ -118,7 +118,7 @@ exports[`toRedirectFiles creates appropriate metadata trailingSlash=undefined: f
<link rel="canonical" href="https://docusaurus.io/abc" /> <link rel="canonical" href="https://docusaurus.io/abc" />
</head> </head>
<script> <script>
window.location.href = 'https://docusaurus.io/abc'; window.location.href = 'https://docusaurus.io/abc' + window.location.search + window.location.hash;
</script> </script>
</html>", </html>",
"<!DOCTYPE html> "<!DOCTYPE html>
@ -129,7 +129,7 @@ exports[`toRedirectFiles creates appropriate metadata trailingSlash=undefined: f
<link rel="canonical" href="https://docusaurus.io/def.html" /> <link rel="canonical" href="https://docusaurus.io/def.html" />
</head> </head>
<script> <script>
window.location.href = 'https://docusaurus.io/def.html'; window.location.href = 'https://docusaurus.io/def.html' + window.location.search + window.location.hash;
</script> </script>
</html>", </html>",
"<!DOCTYPE html> "<!DOCTYPE html>
@ -140,7 +140,7 @@ exports[`toRedirectFiles creates appropriate metadata trailingSlash=undefined: f
<link rel="canonical" href="https://docusaurus.io/" /> <link rel="canonical" href="https://docusaurus.io/" />
</head> </head>
<script> <script>
window.location.href = 'https://docusaurus.io/'; window.location.href = 'https://docusaurus.io/' + window.location.search + window.location.hash;
</script> </script>
</html>", </html>",
] ]

2
packages/docusaurus-plugin-client-redirects/src/templates/redirectPage.template.html.ts
View file

@ -14,7 +14,7 @@ export default `
<link rel="canonical" href="<%= it.toUrl %>" /> <link rel="canonical" href="<%= it.toUrl %>" />
</head> </head>
<script> <script>
window.location.href = '<%= it.toUrl %>'; window.location.href = '<%= it.toUrl %>' + window.location.search + window.location.hash;
</script> </script>
</html> </html>
`; `;

11
website/docusaurus.config.js
View file

@ -39,12 +39,6 @@ function getNextVersionName() {
*/ */
} }
const allDocHomesPaths = [
'/docs/',
'/docs/next/',
...versions.slice(1).map((version) => `/docs/${version}/`),
];
const isDev = process.env.NODE_ENV === 'development'; const isDev = process.env.NODE_ENV === 'development';
const isDeployPreview = const isDeployPreview =
@ -187,9 +181,8 @@ const config = {
({ ({
fromExtensions: ['html'], fromExtensions: ['html'],
createRedirects(routePath) { createRedirects(routePath) {
// Redirect to /docs from /docs/introduction, as introduction has been // Redirect to /docs from /docs/introduction (now docs root doc)
// made the home doc if (routePath === '/docs' || routePath === '/docs/') {
if (allDocHomesPaths.includes(routePath)) {
return [`${routePath}/introduction`]; return [`${routePath}/introduction`];
} }
return []; return [];