@astrojs/starlight/schemas/site-title.ts

Build beautiful, high-performance documentation websites with Astro

import { z } from 'astro/zod';

export const TitleConfigSchema = () =>
	z
		.union([z.string(), z.record(z.string())])
		.describe('Title for your website. Will be used in metadata and as browser tab title.');

// transform the title for runtime use
export const TitleTransformConfigSchema = (defaultLang: string) =>
	TitleConfigSchema().transform((title, ctx) => {
		if (typeof title === 'string') {
			return { [defaultLang]: title };
		}
		if (!title[defaultLang] && title[defaultLang] !== '') {
			ctx.addIssue({
				code: z.ZodIssueCode.custom,
				message: `Title must have a key for the default language "${defaultLang}"`,
			});
			return z.NEVER;
		}
		return title;
	});