Skip to content

Don’t generate invalid <link rel="canonical"/> with missing href #3420

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
delucis merged 2 commits into from
Oct 22, 2025
Merged

Don’t generate invalid <link rel="canonical"/> with missing href #3420

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7319a41
Don’t generate invalid <link rel="canonical"/> with missing href
andersk Sep 11, 2025
337c03a
Merge branch 'main' into invalid-canonical
delucis Oct 22, 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
7 changes: 7 additions & 0 deletions .changeset/quick-apes-grab.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
"@astrojs/starlight": patch
---

Fixes invalid `<head>` output when configuration is missing:
- Omits `<meta property="og:description" />` if Starlight’s `description` option is unset
- Omits `<link rel="canonical" />` and `<meta property="og:url" />` if Astro’s `site` option is unset
12 changes: 9 additions & 3 deletions packages/starlight/utils/head.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,9 @@ export function getHead(
attrs: { name: 'viewport', content: 'width=device-width, initial-scale=1' },
},
{ tag: 'title', content: `${data.title} ${config.titleDelimiter} ${siteTitle}` },
{ tag: 'link', attrs: { rel: 'canonical', href: canonicalHref } },
...(canonicalHref !== undefined
? ([{ tag: 'link', attrs: { rel: 'canonical', href: canonicalHref } }] as const)
: []),
{ tag: 'meta', attrs: { name: 'generator', content: context.generator } },
{
tag: 'meta',
Expand All @@ -51,9 +53,13 @@ export function getHead(
// OpenGraph Tags
{ tag: 'meta', attrs: { property: 'og:title', content: data.title } },
{ tag: 'meta', attrs: { property: 'og:type', content: 'article' } },
{ tag: 'meta', attrs: { property: 'og:url', content: canonicalHref } },
...(canonicalHref !== undefined
? ([{ tag: 'meta', attrs: { property: 'og:url', content: canonicalHref } }] as const)
: []),
{ tag: 'meta', attrs: { property: 'og:locale', content: lang } },
{ tag: 'meta', attrs: { property: 'og:description', content: description } },
...(description !== undefined
? ([{ tag: 'meta', attrs: { property: 'og:description', content: description } }] as const)
: []),
{ tag: 'meta', attrs: { property: 'og:site_name', content: siteTitle } },
// Twitter Tags
{
Expand Down