@astrojs/starlight 0.5.5 → 0.6.0

package/schemas/i18n.ts

@@ -1,173 +1,159 @@
 import { z } from 'astro/zod';
 
 export function i18nSchema() {
-  return starlightI18nSchema().merge(pagefindI18nSchema());
+	return starlightI18nSchema().merge(pagefindI18nSchema());
 }
 
 export function builtinI18nSchema() {
-  return starlightI18nSchema().required().strict().merge(pagefindI18nSchema());
+	return starlightI18nSchema().required().strict().merge(pagefindI18nSchema());
 }
 
 function starlightI18nSchema() {
-  return z
-    .object({
-      'skipLink.label': z
-        .string()
-        .describe(
-          'Text displayed in the accessible “Skip link” when a keyboard user first tabs into a page.'
-        ),
-
-      'search.label': z.string().describe('Text displayed in the search bar.'),
-
-      'search.shortcutLabel': z
-        .string()
-        .describe(
-          'Accessible label for the shortcut key to open the search modal.'
-        ),
-
-      'search.cancelLabel': z
-        .string()
-        .describe('Text for the “Cancel” button that closes the search modal.'),
-
-      'search.devWarning': z
-        .string()
-        .describe('Warning displayed when opening the Search in a dev environment.'),
-
-      'themeSelect.accessibleLabel': z
-        .string()
-        .describe('Accessible label for the theme selection dropdown.'),
-
-      'themeSelect.dark': z.string().describe('Name of the dark color theme.'),
-
-      'themeSelect.light': z
-        .string()
-        .describe('Name of the light color theme.'),
-
-      'themeSelect.auto': z
-        .string()
-        .describe(
-          'Name of the automatic color theme that syncs with system preferences.'
-        ),
-
-      'languageSelect.accessibleLabel': z
-        .string()
-        .describe('Accessible label for the language selection dropdown.'),
-
-      'menuButton.accessibleLabel': z
-        .string()
-        .describe('Accessible label for he mobile menu button.'),
-
-      'sidebarNav.accessibleLabel': z
-        .string()
-        .describe(
-          'Accessible label for the main sidebar `<nav>` element to distinguish it fom other `<nav>` landmarks on the page.'
-        ),
-
-      'tableOfContents.onThisPage': z
-        .string()
-        .describe('Title for the table of contents component.'),
-
-      'tableOfContents.overview': z
-        .string()
-        .describe(
-          'Label used for the first link in the table of contents, linking to the page title.'
-        ),
-
-      'i18n.untranslatedContent': z
-        .string()
-        .describe(
-          'Notice informing users they are on a page that is not yet translated to their language.'
-        ),
-
-      'page.editLink': z.string().describe('Text for the link to edit a page.'),
-
-      'page.lastUpdated': z
-        .string()
-        .describe(
-          'Text displayed in front of the last updated date in the page footer.'
-        ),
-
-      'page.previousLink': z
-        .string()
-        .describe(
-          'Label shown on the “previous page” pagination arrow in the page footer.'
-        ),
-
-      'page.nextLink': z
-        .string()
-        .describe(
-          'Label shown on the “next page” pagination arrow in the page footer.'
-        ),
-
-      '404.text': z
-        .string()
-        .describe('Text shown on Starlight’s default 404 page'),
-    })
-    .partial();
+	return z
+		.object({
+			'skipLink.label': z
+				.string()
+				.describe(
+					'Text displayed in the accessible “Skip link” when a keyboard user first tabs into a page.'
+				),
+
+			'search.label': z.string().describe('Text displayed in the search bar.'),
+
+			'search.shortcutLabel': z
+				.string()
+				.describe('Accessible label for the shortcut key to open the search modal.'),
+
+			'search.cancelLabel': z
+				.string()
+				.describe('Text for the “Cancel” button that closes the search modal.'),
+
+			'search.devWarning': z
+				.string()
+				.describe('Warning displayed when opening the Search in a dev environment.'),
+
+			'themeSelect.accessibleLabel': z
+				.string()
+				.describe('Accessible label for the theme selection dropdown.'),
+
+			'themeSelect.dark': z.string().describe('Name of the dark color theme.'),
+
+			'themeSelect.light': z.string().describe('Name of the light color theme.'),
+
+			'themeSelect.auto': z
+				.string()
+				.describe('Name of the automatic color theme that syncs with system preferences.'),
+
+			'languageSelect.accessibleLabel': z
+				.string()
+				.describe('Accessible label for the language selection dropdown.'),
+
+			'menuButton.accessibleLabel': z
+				.string()
+				.describe('Accessible label for he mobile menu button.'),
+
+			'sidebarNav.accessibleLabel': z
+				.string()
+				.describe(
+					'Accessible label for the main sidebar `<nav>` element to distinguish it fom other `<nav>` landmarks on the page.'
+				),
+
+			'tableOfContents.onThisPage': z
+				.string()
+				.describe('Title for the table of contents component.'),
+
+			'tableOfContents.overview': z
+				.string()
+				.describe(
+					'Label used for the first link in the table of contents, linking to the page title.'
+				),
+
+			'i18n.untranslatedContent': z
+				.string()
+				.describe(
+					'Notice informing users they are on a page that is not yet translated to their language.'
+				),
+
+			'page.editLink': z.string().describe('Text for the link to edit a page.'),
+
+			'page.lastUpdated': z
+				.string()
+				.describe('Text displayed in front of the last updated date in the page footer.'),
+
+			'page.previousLink': z
+				.string()
+				.describe('Label shown on the “previous page” pagination arrow in the page footer.'),
+
+			'page.nextLink': z
+				.string()
+				.describe('Label shown on the “next page” pagination arrow in the page footer.'),
+
+			'404.text': z.string().describe('Text shown on Starlight’s default 404 page'),
+		})
+		.partial();
 }
 
 function pagefindI18nSchema() {
-  return z
-    .object({
-      'pagefind.clear_search': z
-        .string()
-        .describe(
-          'Pagefind UI translation. English default value: `"Clear"`. See https://pagefind.app/docs/ui/#translations'
-        ),
-
-      'pagefind.load_more': z
-        .string()
-        .describe(
-          'Pagefind UI translation. English default value: `"Load more results"`. See https://pagefind.app/docs/ui/#translations'
-        ),
-
-      'pagefind.search_label': z
-        .string()
-        .describe(
-          'Pagefind UI translation. English default value: `"Search this site"`. See https://pagefind.app/docs/ui/#translations'
-        ),
-
-      'pagefind.filters_label': z
-        .string()
-        .describe(
-          'Pagefind UI translation. English default value: `"Filters"`. See https://pagefind.app/docs/ui/#translations'
-        ),
-
-      'pagefind.zero_results': z
-        .string()
-        .describe(
-          'Pagefind UI translation. English default value: `"No results for [SEARCH_TERM]"`. See https://pagefind.app/docs/ui/#translations'
-        ),
-
-      'pagefind.many_results': z
-        .string()
-        .describe(
-          'Pagefind UI translation. English default value: `"[COUNT] results for [SEARCH_TERM]"`. See https://pagefind.app/docs/ui/#translations'
-        ),
-
-      'pagefind.one_result': z
-        .string()
-        .describe(
-          'Pagefind UI translation. English default value: `"[COUNT] result for [SEARCH_TERM]"`. See https://pagefind.app/docs/ui/#translations'
-        ),
-
-      'pagefind.alt_search': z
-        .string()
-        .describe(
-          'Pagefind UI translation. English default value: `"No results for [SEARCH_TERM]. Showing results for [DIFFERENT_TERM] instead"`. See https://pagefind.app/docs/ui/#translations'
-        ),
-
-      'pagefind.search_suggestion': z
-        .string()
-        .describe(
-          'Pagefind UI translation. English default value: `"No results for [SEARCH_TERM]. Try one of the following searches:"`. See https://pagefind.app/docs/ui/#translations'
-        ),
-
-      'pagefind.searching': z
-        .string()
-        .describe(
-          'Pagefind UI translation. English default value: `"Searching for [SEARCH_TERM]..."`. See https://pagefind.app/docs/ui/#translations'
-        ),
-    })
-    .partial();
+	return z
+		.object({
+			'pagefind.clear_search': z
+				.string()
+				.describe(
+					'Pagefind UI translation. English default value: `"Clear"`. See https://pagefind.app/docs/ui/#translations'
+				),
+
+			'pagefind.load_more': z
+				.string()
+				.describe(
+					'Pagefind UI translation. English default value: `"Load more results"`. See https://pagefind.app/docs/ui/#translations'
+				),
+
+			'pagefind.search_label': z
+				.string()
+				.describe(
+					'Pagefind UI translation. English default value: `"Search this site"`. See https://pagefind.app/docs/ui/#translations'
+				),
+
+			'pagefind.filters_label': z
+				.string()
+				.describe(
+					'Pagefind UI translation. English default value: `"Filters"`. See https://pagefind.app/docs/ui/#translations'
+				),
+
+			'pagefind.zero_results': z
+				.string()
+				.describe(
+					'Pagefind UI translation. English default value: `"No results for [SEARCH_TERM]"`. See https://pagefind.app/docs/ui/#translations'
+				),
+
+			'pagefind.many_results': z
+				.string()
+				.describe(
+					'Pagefind UI translation. English default value: `"[COUNT] results for [SEARCH_TERM]"`. See https://pagefind.app/docs/ui/#translations'
+				),
+
+			'pagefind.one_result': z
+				.string()
+				.describe(
+					'Pagefind UI translation. English default value: `"[COUNT] result for [SEARCH_TERM]"`. See https://pagefind.app/docs/ui/#translations'
+				),
+
+			'pagefind.alt_search': z
+				.string()
+				.describe(
+					'Pagefind UI translation. English default value: `"No results for [SEARCH_TERM]. Showing results for [DIFFERENT_TERM] instead"`. See https://pagefind.app/docs/ui/#translations'
+				),
+
+			'pagefind.search_suggestion': z
+				.string()
+				.describe(
+					'Pagefind UI translation. English default value: `"No results for [SEARCH_TERM]. Try one of the following searches:"`. See https://pagefind.app/docs/ui/#translations'
+				),
+
+			'pagefind.searching': z
+				.string()
+				.describe(
+					'Pagefind UI translation. English default value: `"Searching for [SEARCH_TERM]..."`. See https://pagefind.app/docs/ui/#translations'
+				),
+		})
+		.partial();
 }

package/schemas/logo.ts

@@ -1,28 +1,28 @@
 import { z } from 'astro/zod';
 
 export const LogoConfigSchema = () =>
-  z
-    .union([
-      z.object({
-        /** Source of the image file to use. */
-        src: z.string(),
-        /** Alternative text description of the logo. */
-        alt: z.string().default(''),
-        /** Set to `true` to hide the site title text and only show the logo. */
-        replacesTitle: z.boolean().default(false),
-      }),
-      z.object({
-        /** Source of the image file to use in dark mode. */
-        dark: z.string(),
-        /** Source of the image file to use in light mode. */
-        light: z.string(),
-        /** Alternative text description of the logo. */
-        alt: z.string().default(''),
-        /** Set to `true` to hide the site title text and only show the logo. */
-        replacesTitle: z.boolean().default(false),
-      }),
-    ])
-    .optional();
+	z
+		.union([
+			z.object({
+				/** Source of the image file to use. */
+				src: z.string(),
+				/** Alternative text description of the logo. */
+				alt: z.string().default(''),
+				/** Set to `true` to hide the site title text and only show the logo. */
+				replacesTitle: z.boolean().default(false),
+			}),
+			z.object({
+				/** Source of the image file to use in dark mode. */
+				dark: z.string(),
+				/** Source of the image file to use in light mode. */
+				light: z.string(),
+				/** Alternative text description of the logo. */
+				alt: z.string().default(''),
+				/** Set to `true` to hide the site title text and only show the logo. */
+				replacesTitle: z.boolean().default(false),
+			}),
+		])
+		.optional();
 
 export type LogoUserConfig = z.input<ReturnType<typeof LogoConfigSchema>>;
 export type LogoConfig = z.output<ReturnType<typeof LogoConfigSchema>>;

package/schemas/prevNextLink.ts

@@ -1,20 +1,20 @@
 import { z } from 'astro/zod';
 
 export const PrevNextLinkConfigSchema = () =>
-  z
-    .union([
-      z.boolean(),
-      z.string(),
-      z
-        .object({
-          /** The navigation link URL. */
-          link: z.string().optional(),
-          /** The navigation link text. */
-          label: z.string().optional(),
-        })
-        .strict(),
-    ])
-    .optional();
+	z
+		.union([
+			z.boolean(),
+			z.string(),
+			z
+				.object({
+					/** The navigation link URL. */
+					link: z.string().optional(),
+					/** The navigation link text. */
+					label: z.string().optional(),
+				})
+				.strict(),
+		])
+		.optional();
 
 export type PrevNextLinkUserConfig = z.input<ReturnType<typeof PrevNextLinkConfigSchema>>;
 export type PrevNextLinkConfig = z.output<ReturnType<typeof PrevNextLinkConfigSchema>>;

package/schemas/tableOfContents.ts

@@ -3,21 +3,17 @@ import { z } from 'astro/zod';
 const defaults = { minHeadingLevel: 2, maxHeadingLevel: 3 };
 
 export const TableOfContentsSchema = () =>
-  z
-    .union([
-      z.object({
-        /** The level to start including headings at in the table of contents. Default: 2. */
-        minHeadingLevel: z.number().int().min(1).max(6).optional().default(2),
-        /** The level to stop including headings at in the table of contents. Default: 3. */
-        maxHeadingLevel: z.number().int().min(1).max(6).optional().default(3),
-      }),
-      z.boolean().transform((enabled) => (enabled ? defaults : false)),
-    ])
-    .default(defaults)
-    .refine(
-      (toc) => (toc ? toc.minHeadingLevel <= toc.maxHeadingLevel : true),
-      {
-        message:
-          'minHeadingLevel must be less than or equal to maxHeadingLevel',
-      }
-    );
+	z
+		.union([
+			z.object({
+				/** The level to start including headings at in the table of contents. Default: 2. */
+				minHeadingLevel: z.number().int().min(1).max(6).optional().default(2),
+				/** The level to stop including headings at in the table of contents. Default: 3. */
+				maxHeadingLevel: z.number().int().min(1).max(6).optional().default(3),
+			}),
+			z.boolean().transform((enabled) => (enabled ? defaults : false)),
+		])
+		.default(defaults)
+		.refine((toc) => (toc ? toc.minHeadingLevel <= toc.maxHeadingLevel : true), {
+			message: 'minHeadingLevel must be less than or equal to maxHeadingLevel',
+		});

package/style/asides.css

@@ -1,49 +1,49 @@
 .starlight-aside {
-  padding: 1rem;
-  border-inline-start: 0.25rem solid;
-  color: var(--sl-color-white);
+	padding: 1rem;
+	border-inline-start: 0.25rem solid;
+	color: var(--sl-color-white);
 }
 .starlight-aside--note {
-  --sl-color-asides-text-accent: var(--sl-color-blue-high);
-  border-color: var(--sl-color-blue);
-  background-color: var(--sl-color-blue-low);
+	--sl-color-asides-text-accent: var(--sl-color-blue-high);
+	border-color: var(--sl-color-blue);
+	background-color: var(--sl-color-blue-low);
 }
 .starlight-aside--tip {
-  --sl-color-asides-text-accent: var(--sl-color-purple-high);
-  border-color: var(--sl-color-purple);
-  background-color: var(--sl-color-purple-low);
+	--sl-color-asides-text-accent: var(--sl-color-purple-high);
+	border-color: var(--sl-color-purple);
+	background-color: var(--sl-color-purple-low);
 }
 .starlight-aside--caution {
-  --sl-color-asides-text-accent: var(--sl-color-orange-high);
-  border-color: var(--sl-color-orange);
-  background-color: var(--sl-color-orange-low);
+	--sl-color-asides-text-accent: var(--sl-color-orange-high);
+	border-color: var(--sl-color-orange);
+	background-color: var(--sl-color-orange-low);
 }
 .starlight-aside--danger {
-  --sl-color-asides-text-accent: var(--sl-color-red-high);
-  border-color: var(--sl-color-red);
-  background-color: var(--sl-color-red-low);
+	--sl-color-asides-text-accent: var(--sl-color-red-high);
+	border-color: var(--sl-color-red);
+	background-color: var(--sl-color-red-low);
 }
 
 .starlight-aside__title {
-  display: flex;
-  gap: 0.5rem;
-  align-items: center;
-  font-size: var(--sl-text-h5);
-  font-weight: 600;
-  line-height: var(--sl-line-height-headings);
-  color: var(--sl-color-asides-text-accent);
+	display: flex;
+	gap: 0.5rem;
+	align-items: center;
+	font-size: var(--sl-text-h5);
+	font-weight: 600;
+	line-height: var(--sl-line-height-headings);
+	color: var(--sl-color-asides-text-accent);
 }
 
 .starlight-aside__icon {
-  font-size: 1.333em;
-  width: 1em;
-  height: 1em;
+	font-size: 1.333em;
+	width: 1em;
+	height: 1em;
 }
 
 .starlight-aside__title + .starlight-aside__content {
-  margin-top: 0.5rem;
+	margin-top: 0.5rem;
 }
 
 .starlight-aside__content a {
-  color: var(--sl-color-asides-text-accent);
+	color: var(--sl-color-asides-text-accent);
 }