@astrojs/starlight 0.24.0 → 0.24.2

package/integrations/virtual-user-config.ts

@@ -43,10 +43,10 @@ export function vitePluginStarlightUserConfig(
 			? 'src' in opts.logo
 				? `import src from ${resolveId(
 						opts.logo.src
-				  )}; export const logos = { dark: src, light: src };`
+					)}; export const logos = { dark: src, light: src };`
 				: `import dark from ${resolveId(opts.logo.dark)}; import light from ${resolveId(
 						opts.logo.light
-				  )}; export const logos = { dark, light };`
+					)}; export const logos = { dark, light };`
 			: 'export const logos = {};',
 		'virtual:starlight/collection-config': `let userCollections;
 			try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astrojs/starlight",
-  "version": "0.24.0",
+  "version": "0.24.2",
   "description": "Build beautiful, high-performance documentation websites with Astro",
   "keywords": [
     "docs",
@@ -22,10 +22,6 @@
   "exports": {
     ".": "./index.ts",
     "./components": "./components.ts",
-    "./components/Badge.astro": {
-      "types": "./components/Badge.astro.tsx",
-      "import": "./components/Badge.astro"
-    },
     "./components/LanguageSelect.astro": {
       "types": "./components/LanguageSelect.astro.tsx",
       "import": "./components/LanguageSelect.astro"
@@ -178,25 +174,25 @@
     "astro": "^4.8.6"
   },
   "devDependencies": {
-    "@astrojs/markdown-remark": "^4.2.1",
-    "@playwright/test": "^1.43.1",
+    "@astrojs/markdown-remark": "^5.1.0",
+    "@playwright/test": "^1.44.1",
     "@types/node": "^18.16.19",
     "@vitest/coverage-v8": "^1.6.0",
-    "astro": "^4.8.6",
+    "astro": "^4.10.2",
     "vitest": "^1.6.0"
   },
   "dependencies": {
-    "@astrojs/mdx": "^3.0.0",
-    "@astrojs/sitemap": "^3.0.5",
+    "@astrojs/mdx": "^3.1.0",
+    "@astrojs/sitemap": "^3.1.5",
     "@pagefind/default-ui": "^1.0.3",
-    "@types/hast": "^3.0.3",
-    "@types/mdast": "^4.0.3",
-    "astro-expressive-code": "^0.35.2",
+    "@types/hast": "^3.0.4",
+    "@types/mdast": "^4.0.4",
+    "astro-expressive-code": "^0.35.3",
     "bcp-47": "^2.1.0",
     "hast-util-from-html": "^2.0.1",
     "hast-util-select": "^6.0.2",
     "hast-util-to-string": "^3.0.0",
-    "hastscript": "^8.0.0",
+    "hastscript": "^9.0.0",
     "mdast-util-directive": "^3.0.0",
     "mdast-util-to-markdown": "^2.1.0",
     "pagefind": "^1.0.3",

package/schema.ts

@@ -126,8 +126,8 @@ type BaseSchema = BaseSchemaWithoutEffects | z.ZodEffects<BaseSchemaWithoutEffec
 type ExtendedSchema<T extends BaseSchema | never = never> = [T] extends [never]
 	? DefaultSchema
 	: T extends BaseSchema
-	? z.ZodIntersection<DefaultSchema, T>
-	: DefaultSchema;
+		? z.ZodIntersection<DefaultSchema, T>
+		: DefaultSchema;
 
 interface DocsSchemaOpts<T extends BaseSchema> {
 	/**

package/schemas/social.ts

@@ -31,6 +31,7 @@ export const socialLinks = [
 	'hackerOne',
 	'blueSky',
 	'discourse',
+	'zulip',
 ] as const;
 
 export const SocialLinksSchema = () =>
@@ -77,6 +78,7 @@ export const SocialLinksSchema = () =>
 					hackerOne: 'Hacker One',
 					blueSky: 'BlueSky',
 					discourse: 'Discourse',
+					zulip: 'Zulip',
 				}[key];
 				labelledLinks[key] = { label, url };
 			}

package/translations/index.ts

@@ -26,6 +26,7 @@ import uk from './uk.json';
 import hi from './hi.json';
 import zhTW from './zh-TW.json';
 import pl from './pl.json';
+import sk from './sk.json';
 
 const { parse } = builtinI18nSchema();
 
@@ -58,5 +59,6 @@ export default Object.fromEntries(
 		hi,
 		'zh-TW': zhTW,
 		pl,
+		sk,
 	}).map(([key, dict]) => [key, parse(dict)])
 );

package/translations/ko.json

@@ -24,6 +24,6 @@
   "aside.tip": "팁",
   "aside.caution": "주의",
   "aside.danger": "위험",
-  "fileTree.directory": "Directory",
-  "builtWithStarlight.label": "Built with Starlight"
+  "fileTree.directory": "디렉터리",
+  "builtWithStarlight.label": "Starlight로 제작됨"
 }

package/translations/sk.json

@@ -0,0 +1,29 @@
+{
+  "skipLink.label": "Preskočiť na obsah",
+  "search.label": "Hľadať",
+  "search.shortcutLabel": "(Stlačením / hľadajte)",
+  "search.cancelLabel": "Zrušiť",
+  "search.devWarning": "Vyhľadávanie je dostupné len v produkčných zostaveniach. \nSkúste vytvoriť a zobraziť náhľad stránky lokálne.",
+  "themeSelect.accessibleLabel": "Vyberte tému",
+  "themeSelect.dark": "Tmavý",
+  "themeSelect.light": "Svetlý",
+  "themeSelect.auto": "Auto",
+  "languageSelect.accessibleLabel": "Vyberte jazyk",
+  "menuButton.accessibleLabel": "Menu",
+  "sidebarNav.accessibleLabel": "Hlavný",
+  "tableOfContents.onThisPage": "Na tejto stránke",
+  "tableOfContents.overview": "Prehľad",
+  "i18n.untranslatedContent": "Tento obsah zatiaľ nie je dostupný vo vašom jazyku.",
+  "page.editLink": "Upraviť stránku",
+  "page.lastUpdated": "Posledná aktualizácia:",
+  "page.previousLink": "Predchádzajúce",
+  "page.nextLink": "Nasledujúce",
+  "page.draft": "Tento obsah je koncept a nebude zahrnutý do produkčných zostavení.",
+  "404.text": "Stránka nenájdená. Skontrolujte URL alebo skúste použiť vyhľadávacie pole.",
+  "aside.note": "Poznámka",
+  "aside.tip": "Tip",
+  "aside.caution": "Upozornenie",
+  "aside.danger": "Nebezpečenstvo",
+  "fileTree.directory": "Adresár",
+  "builtWithStarlight.label": "Postavené so Starlight"
+}

package/translations/vi.json

@@ -25,5 +25,5 @@
   "aside.caution": "Thận trọng",
   "aside.danger": "Nguy hiểm",
   "fileTree.directory": "Danh mục",
-  "builtWithStarlight.label": "Built with Starlight"
+  "builtWithStarlight.label": "Tạo với Starlight"
 }

package/user-components/Tabs.astro

@@ -119,12 +119,12 @@ const { html, panels } = processPanels(panelHtml);
 						e.key === 'ArrowLeft'
 							? index - 1
 							: e.key === 'ArrowRight'
-							? index + 1
-							: e.key === 'Home'
-							? 0
-							: e.key === 'End'
-							? this.tabs.length - 1
-							: null;
+								? index + 1
+								: e.key === 'Home'
+									? 0
+									: e.key === 'End'
+										? this.tabs.length - 1
+										: null;
 					if (nextIndex === null) return;
 					if (this.tabs[nextIndex]) {
 						e.preventDefault();

package/utils/error-map.ts

@@ -63,7 +63,7 @@ const errorMap: z.ZodErrorMap = (baseError, ctx) => {
 			.map(([key, error]) =>
 				key === baseErrorPath
 					? // Avoid printing the key again if it's a base error
-					  `> ${getTypeOrLiteralMsg(error)}`
+						`> ${getTypeOrLiteralMsg(error)}`
 					: `> ${prefix(key, getTypeOrLiteralMsg(error))}`
 			);
 

package/utils/i18n.ts

@@ -5,6 +5,15 @@ import type { StarlightConfig } from './user-config';
 /** Informations about the built-in default locale used as a fallback when no locales are defined. */
 export const BuiltInDefaultLocale = { ...getLocaleInfo('en'), lang: 'en' };
 
+/**
+ * A list of well-known right-to-left languages used as a fallback when determining the text
+ * direction of a locale is not supported by the `Intl.Locale` API in the current environment.
+ *
+ * @see getLocaleDir()
+ * @see https://en.wikipedia.org/wiki/IETF_language_tag#List_of_common_primary_language_subtags
+ */
+const wellKnownRTL = ['ar', 'fa', 'he', 'prs', 'ps', 'syc', 'ug', 'ur'];
+
 /**
  * Processes the Astro and Starlight i18n configurations to generate/update them accordingly:
  *
@@ -52,8 +61,8 @@ function getAstroI18nConfig(config: StarlightConfig): NonNullable<AstroConfig['i
 						codes: [localeConfig?.lang ?? locale],
 						path: locale === 'root' ? localeConfig?.lang ?? BuiltInDefaultLocale.lang : locale,
 					};
-			  })
-			: [BuiltInDefaultLocale.lang],
+				})
+			: [config.defaultLocale.lang],
 		routing: {
 			prefixDefaultLocale:
 				// Sites with multiple languages without a root locale.
@@ -86,11 +95,11 @@ function getStarlightI18nConfig(
 					isDefaultAstroLocale(astroI18nConfig, locale) && !prefixDefaultLocale
 						? 'root'
 						: isAstroLocaleExtendedConfig(locale)
-						? locale.path
-						: locale,
+							? locale.path
+							: locale,
 					inferStarlightLocaleFromAstroLocale(locale),
 				])
-		  );
+			);
 
 	const defaultAstroLocale = astroI18nConfig.locales.find((locale) =>
 		isDefaultAstroLocale(astroI18nConfig, locale)
@@ -112,8 +121,8 @@ function getStarlightI18nConfig(
 			locale: isMonolingualWithRootLocale
 				? undefined
 				: isAstroLocaleExtendedConfig(defaultAstroLocale)
-				? defaultAstroLocale.codes[0]
-				: defaultAstroLocale,
+					? defaultAstroLocale.codes[0]
+					: defaultAstroLocale,
 		},
 	};
 }
@@ -150,8 +159,7 @@ function getLocaleInfo(lang: string) {
 		if (!label || lang === label) throw new Error('Label not found.');
 		return {
 			label: label[0]?.toLocaleUpperCase(locale) + label.slice(1),
-			// @ts-expect-error - `textInfo` is not part of the `Intl.Locale` type but is available in Node.js 18.0.0+.
-			dir: locale.textInfo.direction as 'ltr' | 'rtl',
+			dir: getLocaleDir(locale),
 		};
 	} catch (error) {
 		throw new AstroError(
@@ -161,6 +169,23 @@ function getLocaleInfo(lang: string) {
 	}
 }
 
+/**
+ * Returns the direction of the passed locale.
+ * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale/getTextInfo
+ */
+function getLocaleDir(locale: Intl.Locale): 'ltr' | 'rtl' {
+	if ('textInfo' in locale) {
+		// @ts-expect-error - `textInfo` is not typed but is available in v8 based environments.
+		return locale.textInfo.direction;
+	} else if ('getTextInfo' in locale) {
+		// @ts-expect-error - `getTextInfo` is not typed but is available in some non-v8 based environments.
+		return locale.getTextInfo().direction;
+	}
+	// Firefox does not support `textInfo` or `getTextInfo` yet so we fallback to a well-known list
+	// of right-to-left languages.
+	return wellKnownRTL.includes(locale.language) ? 'rtl' : 'ltr';
+}
+
 /**
  * Get the string for the passed language from a dictionary object.
  *

package/utils/navigation.ts

@@ -223,7 +223,7 @@ function getOrder(routeOrDir: Route | Dir): number {
 	return isDir(routeOrDir)
 		? Math.min(...Object.values(routeOrDir).flatMap(getOrder))
 		: // If no order value is found, set it to the largest number possible.
-		  routeOrDir.entry.data.sidebar.order ?? Number.MAX_VALUE;
+			routeOrDir.entry.data.sidebar.order ?? Number.MAX_VALUE;
 }
 
 /** Sort a directory’s entries by user-specified order or alphabetically if no order specified. */

package/utils/route-data.ts

@@ -67,8 +67,8 @@ export function getToC({ entry, locale, headings }: PageProps) {
 		entry.data.template === 'splash'
 			? false
 			: entry.data.tableOfContents !== undefined
-			? entry.data.tableOfContents
-			: config.tableOfContents;
+				? entry.data.tableOfContents
+				: config.tableOfContents;
 	if (!tocConfig) return;
 	const t = useTranslations(locale);
 	return {

package/utils/slugs.ts

@@ -52,8 +52,8 @@ export function slugToParam(slug: string): string | undefined {
 	return slug === 'index' || slug === ''
 		? undefined
 		: slug.endsWith('/index')
-		? slug.replace(/\/index$/, '')
-		: slug;
+			? slug.replace(/\/index$/, '')
+			: slug;
 }
 
 export function slugToPathname(slug: string): string {

package/utils/starlight-page.ts

@@ -292,10 +292,10 @@ type RemoveIndexSignature<T> = {
 	[K in keyof T as string extends K
 		? never
 		: number extends K
-		? never
-		: symbol extends K
-		? never
-		: K]: T[K];
+			? never
+			: symbol extends K
+				? never
+				: K]: T[K];
 };
 
 // https://www.totaltypescript.com/concepts/the-prettify-helper

package/utils/user-config.ts

@@ -225,7 +225,11 @@ export const StarlightConfigSchema = UserConfigSchema.strict().transform(
 		// Monolingual sites with only one non-root locale needs their configuration to be defined in
 		// `config.locales` so that slugs can be correctly generated by taking into consideration the
 		// base path at which a language is served which is the key of the `config.locales` object.
-		if (locales !== undefined && configuredLocales.length >= 1) {
+		if (
+			locales !== undefined &&
+			(configuredLocales.length > 1 ||
+				(configuredLocales.length === 1 && locales.root === undefined))
+		) {
 			// Make sure we can find the default locale and if not, help the user set it.
 			// We treat the root locale as the default if present and no explicit default is set.
 			const defaultLocaleConfig = locales[defaultLocale || 'root'];