Make logo href customizable

[mavam]

What version of starlight are you using?

latest

What is your idea?

I'd like my logo link to point to a different site than the docs main page.

To this end, it would be nice if I can just add a configuration option for the href in the logo:

starlight({
  title: 'Docs With My Logo',
  logo: {
    src: './src/assets/my-logo.svg',
    href: 'my-domain.example',
    replacesTitle: true,
  },
}),

(This feature request is reopening my PR.)

Why is this feature necessary?

I have a docs site and would like to the main product page when clicking the logo.

There's a cumbersome workaround for developers, but not users:

import { defineRouteMiddleware } from '@astrojs/starlight/route-data';

export const onRequest = defineRouteMiddleware((context) => {
	context.locals.starlightRoute.siteTitleHref = 'https://my-domain.example';
});

Since this is not ergonomic, I propose a first-class configuration option instead.

Do you have examples of this feature in other projects?

n/a

Participation

• I am willing to submit a pull request for this feature.