Skip to content

Support links with any protocol in sidebars #4092

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 5 commits into from
Jul 22, 2026
Merged

Support links with any protocol in sidebars #4092

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
cb7e36c
Add failing tests
delucis Jul 21, 2026
59b9e33
Handle sidebar links by checking for any protocol component
delucis Jul 21, 2026
49b56c4
Loosen `hasProtocol` check to allow colons in path names
delucis Jul 21, 2026
0cadbbd
Add changeset
delucis Jul 21, 2026
34c46d8
Use slower but more correct protocol check
delucis Jul 21, 2026
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
5 changes: 5 additions & 0 deletions .changeset/every-breads-camp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@astrojs/starlight': patch
---

Fixes support for links containing a protocol like `mailto:` in the sidebar
8 changes: 8 additions & 0 deletions packages/starlight/__tests__/sidebar/navigation-attributes.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,14 @@ describe('getSidebar', () => {
"label": "API (deprecated)",
"type": "group",
},
{
"attrs": {},
"badge": undefined,
"href": "mailto:me@example.com",
"isCurrent": false,
"label": "E-mail me",
"type": "link",
},
]
`);
});
Expand Down
8 changes: 8 additions & 0 deletions packages/starlight/__tests__/sidebar/navigation-badges.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,14 @@ describe('getSidebar', () => {
"label": "API (deprecated)",
"type": "group",
},
{
"attrs": {},
"badge": undefined,
"href": "mailto:me@example.com",
"isCurrent": false,
"label": "E-mail me",
"type": "link",
},
]
`);
});
Expand Down
8 changes: 8 additions & 0 deletions packages/starlight/__tests__/sidebar/navigation-hidden.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,14 @@ describe('getSidebar', () => {
"label": "API (deprecated)",
"type": "group",
},
{
"attrs": {},
"badge": undefined,
"href": "mailto:me@example.com",
"isCurrent": false,
"label": "E-mail me",
"type": "link",
},
]
`);
});
Expand Down
8 changes: 8 additions & 0 deletions packages/starlight/__tests__/sidebar/navigation-order.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,14 @@ describe('getSidebar', () => {
"label": "API (deprecated)",
"type": "group",
},
{
"attrs": {},
"badge": undefined,
"href": "mailto:me@example.com",
"isCurrent": false,
"label": "E-mail me",
"type": "link",
},
]
`);
});
Expand Down
8 changes: 8 additions & 0 deletions packages/starlight/__tests__/sidebar/navigation-unicode.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,14 @@ describe('getSidebar', () => {
"label": "API (deprecated)",
"type": "group",
},
{
"attrs": {},
"badge": undefined,
"href": "mailto:me@example.com",
"isCurrent": false,
"label": "E-mail me",
"type": "link",
},
]
`);
});
Expand Down
8 changes: 8 additions & 0 deletions packages/starlight/__tests__/sidebar/navigation.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,14 @@ describe('getSidebar', () => {
"label": "API (deprecated)",
"type": "group",
},
{
"attrs": {},
"badge": undefined,
"href": "mailto:me@example.com",
"isCurrent": false,
"label": "E-mail me",
"type": "link",
},
]
`);
});
Expand Down
5 changes: 5 additions & 0 deletions packages/starlight/__tests__/sidebar/vitest.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,5 +50,10 @@ export default defineVitestConfig({
label: 'API (deprecated)',
items: [{ autogenerate: { directory: '/Deprecated API/' } }],
},
// A link using the `mailto:` protocol.
{
label: 'E-mail me',
link: 'mailto:me@example.com',
},
],
});
6 changes: 3 additions & 3 deletions packages/starlight/utils/navigation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ import type {
SidebarAutogenerateRouteData,
} from './routing/types';
import { localeToLang, localizedFilePath, slugToPathname } from './slugs';
import { isAbsoluteUrl } from './url';
import { hasProtocol } from './url';
import type { StarlightConfig } from './user-config';

const DirKey = Symbol('DirKey');
Expand Down Expand Up @@ -120,7 +120,7 @@ function entriesFromAutogenerateConfig(
/** Create a link entry from a manual link item in user config. */
function linkFromSidebarLinkItem(item: SidebarLinkItem, locale: string | undefined) {
let href = item.link;
if (!isAbsoluteUrl(href)) {
if (!hasProtocol(href)) {
href = ensureLeadingSlash(href);
// Inject current locale into link.
if (locale) href = '/' + locale + href;
Expand Down Expand Up @@ -188,7 +188,7 @@ function makeSidebarLink(
opts: MakeLinkOptions & { autogenerate: SidebarAutogenerateRouteData }
): SidebarAutoLink;
function makeSidebarLink({ attrs, badge, href, label, autogenerate }: MakeLinkOptions) {
if (!isAbsoluteUrl(href)) {
if (!hasProtocol(href)) {
href = formatPath(href);
}
return makeLink({ label, href, badge, attrs, autogenerate });
Expand Down
8 changes: 8 additions & 0 deletions packages/starlight/utils/url.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,11 @@ const HTTPProtocolRegEx = /^https?:\/\//;

/** Check if a string starts with one of `http://` or `https://`. */
export const isAbsoluteUrl = (link: string) => HTTPProtocolRegEx.test(link);

/** Check if a string contains a protocol (e.g., `http:`, `https:`, `mailto:`). */
export const hasProtocol = (link: string) => {
const colonIndex = link.indexOf(':');
if (colonIndex === -1) return false;
const slashIndex = link.indexOf('/');
return slashIndex === -1 || colonIndex < slashIndex;
};
Comment thread
delucis marked this conversation as resolved.
Resolved
Loading