Skip to content

Output generic alternates for page metadata #3804

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Nov 14, 2025
Merged

Output generic alternates for page metadata #3804

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b3f8736
Output generic alternates in the metadata
taranvohra Nov 13, 2025
c891663
undo rollout %
taranvohra Nov 13, 2025
86f2465
Merge branch 'main' into taran/generic-alternates
taranvohra Nov 13, 2025
287fb28
review: comment
taranvohra Nov 14, 2025
123325b
Merge branch 'main' into taran/generic-alternates
taranvohra Nov 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 26 additions & 7 deletions packages/gitbook/src/components/SitePage/SitePage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,21 +160,36 @@ export async function generateSitePageMetadata(props: SitePageProps): Promise<Me

const canonical = (
pageMetaLinks?.canonical
? new URL(pageMetaLinks.canonical).toString()
? new URL(
// If the canonical link is an absolute URL, use it as is.
URL.canParse(pageMetaLinks.canonical)
? pageMetaLinks.canonical
: linker.toAbsoluteURL(pageMetaLinks.canonical)
).toString()
: // If no canonical is set, use the current page URL (default case)
linker.toAbsoluteURL(linker.toPathForPage({ pages: revision.pages, page }))
).replace(/\/+$/, ''); // Trim trailing slashes in canonical URL to match the redirect behavior

const languages = pageMetaLinks?.alternates.reduce(
const alternates = pageMetaLinks?.alternates.reduce<{
languages: Record<string, string>;
generic: Array<{
title?: string;
url: string;
}>;
}>(
(acc, alt) => {
// TODO: We can only add language alternates for now as that's all Next.js API supports
// generic alternates are not supported yet
if (alt.space?.language) {
acc[alt.space.language] = alt.href;
acc.languages[alt.space.language] = URL.canParse(alt.href)
? alt.href
: linker.toAbsoluteURL(alt.href);
} else {
acc.generic.push({
url: URL.canParse(alt.href) ? alt.href : linker.toAbsoluteURL(alt.href),
});
}
return acc;
},
{} as Record<TranslationLanguage, string>
{ languages: {}, generic: [] }
);

return {
Expand All @@ -189,9 +204,13 @@ export async function generateSitePageMetadata(props: SitePageProps): Promise<Me
description: page.description ?? '',
alternates: {
canonical,
languages,
languages: alternates?.languages,
types: {
'text/markdown': `${linker.toAbsoluteURL(linker.toPathInSpace(page.path))}.md`,
// Currently it will output with an empty "type" like <link rel="alternate" href="..." type />
// Team at Vercel is aware of this and will ensure it will be omitted when the value is empty in future versions of Next.js
// https://gitbook.slack.com/archives/C04K6MV5W1K/p1763034072958419?thread_ts=1762937203.511629&cid=C04K6MV5W1K
...(alternates?.generic ? { '': alternates?.generic } : {}),
},
},
openGraph: {
Expand Down
Loading