@astrojs/starlight 0.41.9 → 0.41.11

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @astrojs/starlight
 
+## 0.41.11
+
+### Patch Changes
+
+- [#4167](https://github.com/withastro/starlight/pull/4167) [`32a5e29`](https://github.com/withastro/starlight/commit/32a5e29127c13946ce746c36d7cb194f35d11952) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Fixes a layout issue and anchor links appearing for hidden headings, e.g. footnote headings, when `markdown.headingLinks` is enabled or the `<AnchorHeading>` component is used.
+
+- [#4148](https://github.com/withastro/starlight/pull/4148) [`cdfafd8`](https://github.com/withastro/starlight/commit/cdfafd8eedbbd6653cd6a1d3b1542b44ed1ba19e) Thanks [@ematipico](https://github.com/ematipico)! - Optimizes sidebar data generation logic to speed up sites with large sidebars
+
+## 0.41.10
+
+### Patch Changes
+
+- [#4160](https://github.com/withastro/starlight/pull/4160) [`88442c3`](https://github.com/withastro/starlight/commit/88442c333612058cb1b2c56ef689053a5994e31e) Thanks [@ArmandPhilippot](https://github.com/ArmandPhilippot)! - Adds the missing translations for Expressive Code in the following locales: `ar`, `hi`, `it`, `ja`, `ko`, `pt`, `zh-CN`, and `zh-TW`.
+
+- [#4156](https://github.com/withastro/starlight/pull/4156) [`57af92d`](https://github.com/withastro/starlight/commit/57af92d91f9a9d0936a06efb4387898aded62aa9) Thanks [@pyxelr](https://github.com/pyxelr)! - Adds 1 new icon: `hypothesis`
+
+- [#4159](https://github.com/withastro/starlight/pull/4159) [`a0e0ba2`](https://github.com/withastro/starlight/commit/a0e0ba263c93bab214222b798b52a759fb799ba7) Thanks [@trueberryless](https://github.com/trueberryless)! - Adds 1 new icon: `npmx`
+
 ## 0.41.9
 
 ### Patch Changes

package/components-internals/Icons.ts

@@ -176,6 +176,8 @@ export const BuiltInIcons = {
 		'<path d="M12.525.02c1.31-.02 2.61-.01 3.91-.02.08 1.53.63 3.09 1.75 4.17 1.12 1.11 2.7 1.62 4.24 1.79v4.03c-1.44-.05-2.89-.35-4.2-.97-.57-.26-1.1-.59-1.62-.93-.01 2.92.01 5.84-.02 8.75-.08 1.4-.54 2.79-1.35 3.94-1.31 1.92-3.58 3.17-5.91 3.21-1.43.08-2.86-.31-4.08-1.03-2.02-1.19-3.44-3.37-3.65-5.71-.02-.5-.03-1-.01-1.49.18-1.9 1.12-3.72 2.58-4.96 1.66-1.44 3.98-2.13 6.15-1.72.02 1.48-.04 2.96-.04 4.44-.99-.32-2.15-.23-3.02.37-.63.41-1.11 1.04-1.36 1.75-.21.51-.15 1.07-.14 1.61.24 1.64 1.82 3.02 3.5 2.87 1.12-.01 2.19-.66 2.77-1.61.19-.33.4-.67.41-1.06.1-1.79.06-3.57.07-5.36.01-4.03-.01-8.05.02-12.07z"/>',
 	goodreads:
 		'<path d="M17.35.03c.42-.09.85.03 1.17.32q.54.45.56 1.15c-.02.46-.25.88-.61 1.16l-2.18 1.75a.6.6 0 0 0-.26.43.5.5 0 0 0 .11.42 5.9 5.9 0 0 1 .84 6.58 5.96 5.96 0 0 1-7.5 2.93 1 1 0 0 0-.5-.01c-.23.07-.3.18-.46.38l-.01.02-.94 1.26s-.8.98.45.93a40 40 0 0 1 5.44 0c2.64.17 3.8 1.9 3.8 3.27 0 1.62-1.03 3.38-3.8 3.38a118 118 0 0 0-5.52-.03l-.83.02-.52.01c-.71 0-1.65-.19-1.66-1.07-.01-.73.62-1.12 1.1-1.17.44-.05.82 0 1.25.06l.81.1q.28 0 .56.03c.53.04 1.1.08 1.92.09l1.03.01c.7.01.94.02 1.28-.01 1.24-.12 1.83-.61 1.83-1.38q-.02-1.2-1.7-1.41c-1.56-.22-2.33-.17-3.72-.08l-1.67.1c-.6.03-2.45.02-2.68-1.5-.05-.41-.07-1.11.8-2.32l.76-1c.36-.5.58-.9.05-1.56 0 0-.4-.47-.52-.64a5.9 5.9 0 0 1-.45-6.11 6.14 6.14 0 0 1 8.37-2.58c.25.14.44.2.66.16.2-.03.27-.17.36-.35l.07-.12.53-1.03.73-1.4a1.5 1.5 0 0 1 1.05-.8M9.19 13.25c1.86.9 3.92.21 5.26-2.47 1.35-2.7.82-5.1-1.04-6.02C10.9 3.54 8.8 5.83 8 7.41c-1.35 2.7-.71 4.89 1.15 5.82Z"/>',
+	hypothesis:
+		'<path d="M3.43 0C2.49 0 1.7.77 1.7 1.72v17.14c0 .94.78 1.71 1.72 1.71h5.95L11.99 24l2.63-3.43h5.95c.93 0 1.72-.77 1.72-1.71V1.72c0-.95-.8-1.72-1.72-1.72zm1.7 3.43h2.59v6s.86-1.71 2.56-1.71c1.72 0 3.46.85 3.46 3.52v5.9h-2.59V12c0-1.39-.88-1.93-1.73-1.71-.86.21-1.7 1.12-1.7 3v3.85h-2.6zM18 13.72c.95 0 1.72.78 1.72 1.7A1.7 1.7 0 0 1 18 17.13a1.7 1.7 0 0 1-1.7-1.71c0-.92.75-1.71 1.7-1.71z"/>',
 	astro:
 		'<path d="M7.233 15.856c-.456 1.5-.132 3.586.948 4.57v-.036l.036-.096c.132-.636.648-1.032 1.309-1.008.612.012.96.336 1.044 1.044.036.264.036.528.048.803v.084c0 .6.168 1.176.504 1.68.3.48.72.851 1.284 1.103l-.024-.048-.024-.096c-.42-1.26-.12-2.135.984-2.879l.336-.227.745-.492a3.647 3.647 0 0 0 1.536-2.603c.06-.456 0-.9-.132-1.331l-.18.12c-1.668.887-3.577 1.2-5.425.84-1.117-.169-2.197-.48-3-1.416l.011-.012ZM2 15.592s3.205-1.559 6.421-1.559l2.437-7.508c.084-.36.348-.6.648-.6.3 0 .552.24.648.612l2.425 7.496c3.816 0 6.421 1.56 6.421 1.56L15.539.72c-.144-.444-.42-.72-.768-.72H8.24c-.348 0-.6.276-.768.72L2 15.592Z"/>',
 	solidjs:
@@ -224,6 +226,7 @@ export const BuiltInIcons = {
 	sketch:
 		'<path d="m.29 8.99 4.8-6.53a.6.6 0 0 1 .42-.24l6.42-.71a.6.6 0 0 1 .14 0l6.42.71a.6.6 0 0 1 .42.24L23.7 9a.6.6 0 0 1-.02.75L12.34 22.86a.45.45 0 0 1-.68 0L.31 9.74a.6.6 0 0 1-.02-.75Zm13.36-5.55a.15.15 0 0 0-.21.2l3.04 3.75a.3.3 0 0 1-.23.49h-8.5a.3.3 0 0 1-.23-.5l3.05-3.74a.15.15 0 0 0-.22-.2L5.8 7.72a.3.3 0 0 1-.5-.24l.21-3.04a.15.15 0 0 0-.3-.05l-.99 3.48a.75.75 0 0 1-.48.5l-2.19.71a.15.15 0 0 0 .05.3h2.1a.75.75 0 0 1 .64.34l5.56 8.74a.23.23 0 0 0 .39-.22L6.3 10.02a.45.45 0 0 1 .4-.64h10.57a.45.45 0 0 1 .4.64l-3.98 8.22a.22.22 0 0 0 .4.22l5.55-8.74a.75.75 0 0 1 .64-.34h2.04a.15.15 0 0 0 .04-.3l-2.12-.7a.75.75 0 0 1-.48-.51l-1-3.48a.15.15 0 0 0-.17-.1.15.15 0 0 0-.12.15l.22 3.04a.3.3 0 0 1-.51.24l-4.54-4.28Z"/>',
 	npm: '<path d="M1.76 0h20.48a1.76 1.76 0 0 1 1.76 1.76v20.48a1.76 1.76 0 0 1-1.76 1.76H1.76A1.76 1.76 0 0 1 0 22.24V1.76A1.76 1.76 0 0 1 1.76 0zM5.11 19.16h6.93V8.8h3.47v10.36h3.47V5.34H5.13v13.82z"></path>',
+	npmx: '<path d="M2.77 16.81h3.77v3.72H2.77zM18.8.12l-.57 1.6-7.27 20.55-.56 1.61h2.43l.57-1.6 1.84-5.2 6-16.96z"/>',
 	sourcehut:
 		'<path d="M12 20a8 8 0 0 1-8-8 8 8 0 0 1 8-8 8 8 0 0 1 8 8 8 8 0 0 1-8 8m0-18A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10A10 10 0 0 0 12 2"/>',
 	substack:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astrojs/starlight",
-  "version": "0.41.9",
+  "version": "0.41.11",
   "description": "Build beautiful, high-performance documentation websites with Astro",
   "keywords": [
     "docs",
@@ -53,6 +53,7 @@
   "devDependencies": {
     "@astrojs/markdown-remark": "^7.2.2",
     "@playwright/test": "^1.61.1",
+    "@codspeed/vitest-plugin": "^5.7.1",
     "@types/node": "^22.19.17",
     "@vitest/coverage-v8": "^4.1.5",
     "astro": "^7.1.6",
@@ -96,6 +97,8 @@
   "scripts": {
     "test": "VITE_CONFIG_NATIVE_IGNORE_WARNING=true vitest",
     "test:coverage": "VITE_CONFIG_NATIVE_IGNORE_WARNING=true vitest run --coverage",
+    "bench": "pnpm bench:functional",
+    "bench:functional": "VITE_CONFIG_NATIVE_IGNORE_WARNING=true vitest bench --run --config vitest.functional.bench.config.ts __bench_fn__/*.bench.ts",
     "test:e2e": "playwright install --with-deps chromium && playwright test",
     "test:e2e:ci": "playwright test"
   }

package/style/anchor-links.css

@@ -45,6 +45,11 @@ how we do it.
 		line-height: var(--sl-line-height-headings);
 	}
 
+	/* If the heading is hidden, remove the wrapper's box to avoid unwanted spacing. */
+	.sl-markdown-content .sl-heading-wrapper:has(> :first-child:is(.sr-only, [hidden])) {
+		display: contents;
+	}
+
 	/* We need to apply the same rule we use for heading spacing to the parent wrapper. */
 	.sl-markdown-content
 		:not(h1, h2, h3, h4, h5, h6, .sl-heading-wrapper)
@@ -75,7 +80,7 @@ how we do it.
 	/* ======================================================
    HEADING
    ====================================================== */
-	.sl-markdown-content .sl-heading-wrapper > :first-child {
+	.sl-markdown-content .sl-heading-wrapper > :first-child:not([hidden]) {
 		display: inline;
 		/* Apply end-of-line padding to the heading element. */
 		padding-inline-end: var(--sl-anchor-icon-space);
@@ -96,6 +101,13 @@ how we do it.
 		display: inline-flex;
 	}
 
+	/* Hide anchor links for headings that are hidden. */
+	.sl-markdown-content
+		.sl-heading-wrapper:has(> :first-child:is(.sr-only, [hidden]))
+		> .sl-anchor-link {
+		display: none;
+	}
+
 	/* Increase clickable area for anchor links with a pseudo element that doesn’t impact layout. */
 	.sl-markdown-content .sl-anchor-link::after {
 		content: '';

package/translations/ar.json

@@ -24,6 +24,9 @@
   "aside.tip": "نصيحة",
   "aside.caution": "تنبيه",
   "aside.danger": "تحذير",
+  "expressiveCode.terminalWindowFallbackTitle": "نافذة طرفيّة",
+  "expressiveCode.copyButtonTooltip": "نسخ إلى الحافظة",
+  "expressiveCode.copyButtonCopied": "تم النسخ!",
   "fileTree.directory": "Directory",
   "builtWithStarlight.label": "طوِّر بواسطة Starlight",
   "heading.anchorLabel": "Section titled “{{title}}”"

package/translations/hi.json

@@ -24,6 +24,9 @@
   "aside.tip": "संकेत",
   "aside.caution": "सावधानी",
   "aside.danger": "खतरा",
+  "expressiveCode.terminalWindowFallbackTitle": "टर्मिनल विंडो",
+  "expressiveCode.copyButtonTooltip": "क्लिपबोर्ड पर कॉपी करें",
+  "expressiveCode.copyButtonCopied": "कॉपी हो गया!",
   "fileTree.directory": "Directory",
   "builtWithStarlight.label": "Starlight द्वारा निर्मित",
   "heading.anchorLabel": "Section titled “{{title}}”"

package/translations/it.json

@@ -24,6 +24,9 @@
   "aside.tip": "Consiglio",
   "aside.caution": "Attenzione",
   "aside.danger": "Pericolo",
+  "expressiveCode.terminalWindowFallbackTitle": "Finestra del terminale",
+  "expressiveCode.copyButtonTooltip": "Copia",
+  "expressiveCode.copyButtonCopied": "Copiato!",
   "fileTree.directory": "Directory",
   "builtWithStarlight.label": "Built with Starlight",
   "heading.anchorLabel": "Sezione intitolata “{{title}}”"

package/translations/ja.json

@@ -24,6 +24,9 @@
   "aside.tip": "ヒント",
   "aside.caution": "注意",
   "aside.danger": "危険",
+  "expressiveCode.terminalWindowFallbackTitle": "ターミナルウィンドウ",
+  "expressiveCode.copyButtonTooltip": "クリップボードにコピー",
+  "expressiveCode.copyButtonCopied": "コピーしました！",
   "fileTree.directory": "ディレクトリ",
   "builtWithStarlight.label": "Starlightで作成",
   "heading.anchorLabel": "Section titled “{{title}}”"

package/translations/ko.json

@@ -24,6 +24,9 @@
   "aside.tip": "팁",
   "aside.caution": "주의",
   "aside.danger": "위험",
+  "expressiveCode.terminalWindowFallbackTitle": "터미널 창",
+  "expressiveCode.copyButtonTooltip": "클립보드로 복사",
+  "expressiveCode.copyButtonCopied": "복사 완료!",
   "fileTree.directory": "디렉터리",
   "builtWithStarlight.label": "이 웹사이트는 Starlight로 제작되었습니다.",
   "heading.anchorLabel": "섹션 제목: “{{title}}”"

package/translations/pt.json

@@ -24,6 +24,9 @@
   "aside.tip": "Dica",
   "aside.caution": "Cuidado",
   "aside.danger": "Perigo",
+  "expressiveCode.terminalWindowFallbackTitle": "Janela do terminal",
+  "expressiveCode.copyButtonTooltip": "Copiar para área de transferência",
+  "expressiveCode.copyButtonCopied": "Copiado!",
   "fileTree.directory": "Directory",
   "builtWithStarlight.label": "Feito com Starlight",
   "heading.anchorLabel": "Seção intitulada “{{title}}”"

package/translations/zh-CN.json

@@ -24,6 +24,9 @@
   "aside.tip": "提示",
   "aside.caution": "警告",
   "aside.danger": "危险",
+  "expressiveCode.terminalWindowFallbackTitle": "终端窗口",
+  "expressiveCode.copyButtonTooltip": "复制到剪贴板",
+  "expressiveCode.copyButtonCopied": "复制成功！",
   "fileTree.directory": "文件夹",
   "builtWithStarlight.label": "基于 Starlight 构建",
   "heading.anchorLabel": "Section titled “{{title}}”"

package/translations/zh-TW.json

@@ -24,6 +24,9 @@
   "aside.tip": "提示",
   "aside.caution": "警告",
   "aside.danger": "危險",
+  "expressiveCode.terminalWindowFallbackTitle": "終端機視窗",
+  "expressiveCode.copyButtonTooltip": "複製到剪貼簿",
+  "expressiveCode.copyButtonCopied": "複製成功！",
   "fileTree.directory": "目錄",
   "builtWithStarlight.label": "Built with Starlight",
   "heading.anchorLabel": "Section titled “{{title}}”"

package/utils/navigation.ts

@@ -20,7 +20,7 @@ import {
 	stripExtension,
 	stripLeadingAndTrailingSlashes,
 } from './path';
-import { getLocaleRoutes, routes } from './routing';
+import { getLocaleRoutes, getRouteById } from './routing';
 import type {
 	SidebarGroup,
 	SidebarLink,
@@ -42,6 +42,7 @@ const SlugKey = Symbol('SlugKey');
 const rootAutogenerate: SidebarAutogenerateRouteData = { directory: '' };
 
 const neverPathFormatter = createPathFormatter({ trailingSlash: 'never' });
+const sidebarCollator = new Intl.Collator(localeToLang(undefined));
 
 const docsCollectionPathFromRoot = getCollectionPathFromRoot('docs', project);
 
@@ -142,7 +143,7 @@ function linkFromInternalSidebarLinkItem(
 	// Astro passes root `index.[md|mdx]` entries with a slug of `index`
 	const slug = item.slug === 'index' ? '' : item.slug;
 	const localizedSlug = locale ? (slug ? locale + '/' + slug : locale) : slug;
-	const route = routes.find((entry) => localizedSlug === entry.id);
+	const route = getRouteById(localizedSlug);
 	if (!route) {
 		const hasExternalSlashes = item.slug.at(0) === '/' || item.slug.at(-1) === '/';
 		if (hasExternalSlashes) {
@@ -206,11 +207,6 @@ function makeLink({ attrs = {}, badge, autogenerate, ...opts }: MakeLinkOptions)
 	};
 }
 
-/** Test if two paths are equivalent even if formatted differently. */
-function pathsMatch(pathA: string, pathB: string) {
-	return neverPathFormatter(pathA) === neverPathFormatter(pathB);
-}
-
 /** Get the segments leading to a page. */
 function getBreadcrumbs(path: string, baseDir: string): string[] {
 	// Strip extension from path.
@@ -294,21 +290,26 @@ function linkFromRoute(
  * Directories have the weight of the lowest weighted route they contain.
  */
 function getOrder(routeOrDir: Route | Dir): number {
-	return isDir(routeOrDir)
+	const cachedOrder = orderByEntry.get(routeOrDir);
+	if (cachedOrder !== undefined) return cachedOrder;
+	const order = 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);
+	orderByEntry.set(routeOrDir, order);
+	return order;
 }
 
+const orderByEntry = new WeakMap<Dir | Route, number>();
+
 /** Sort a directory’s entries by user-specified order or alphabetically if no order specified. */
 function sortDirEntries(dir: [string, Dir | Route][]): [string, Dir | Route][] {
-	const collator = new Intl.Collator(localeToLang(undefined));
 	return dir.sort(([_keyA, a], [_keyB, b]) => {
 		const [aOrder, bOrder] = [getOrder(a), getOrder(b)];
 		// Pages are sorted by order in ascending order.
 		if (aOrder !== bOrder) return aOrder < bOrder ? -1 : 1;
 		// If two pages have the same order value they will be sorted by their slug.
-		return collator.compare(isDir(a) ? a[SlugKey] : a.id, isDir(b) ? b[SlugKey] : b.id);
+		return sidebarCollator.compare(isDir(a) ? a[SlugKey] : a.id, isDir(b) ? b[SlugKey] : b.id);
 	});
 }
 
@@ -435,19 +436,20 @@ function setIntermediateSidebarCurrentEntry(
 
 /** Finds the current page in a sidebar. */
 function getSidebarCurrentEntry(sidebar: SidebarEntry[], pathname: string): SidebarLink | null {
-	for (const entry of sidebar) {
-		if (entry.type === 'link' && pathsMatch(encodeURI(entry.href), pathname)) {
-			return entry;
-		}
-
-		if (entry.type === 'group') {
-			const currentEntry = getSidebarCurrentEntry(entry.entries, pathname);
-			if (currentEntry) return currentEntry;
+	let entriesByPath = sidebarEntriesByPath.get(sidebar);
+	if (!entriesByPath) {
+		entriesByPath = new Map();
+		for (const entry of flattenSidebar(sidebar)) {
+			const path = neverPathFormatter(encodeURI(entry.href));
+			if (!entriesByPath.has(path)) entriesByPath.set(path, entry);
 		}
+		sidebarEntriesByPath.set(sidebar, entriesByPath);
 	}
-	return null;
+	return entriesByPath.get(neverPathFormatter(pathname)) ?? null;
 }
 
+const sidebarEntriesByPath = new WeakMap<SidebarEntry[], Map<string, SidebarLink>>();
+
 /** Generates a deterministic string based on the content of the passed sidebar. */
 export function getSidebarHash(sidebar: SidebarEntry[]): string {
 	let hash = 0;
@@ -472,11 +474,17 @@ function recursivelyBuildSidebarIdentity(sidebar: SidebarEntry[]): string {
 
 /** Turn the nested tree structure of a sidebar into a flat list of all the links. */
 export function flattenSidebar(sidebar: SidebarEntry[]): SidebarLink[] {
-	return sidebar.flatMap((entry) =>
+	const cachedSidebar = flattenedSidebars.get(sidebar);
+	if (cachedSidebar) return cachedSidebar;
+	const flattenedSidebar = sidebar.flatMap((entry) =>
 		entry.type === 'group' ? flattenSidebar(entry.entries) : entry
 	);
+	flattenedSidebars.set(sidebar, flattenedSidebar);
+	return flattenedSidebar;
 }
 
+const flattenedSidebars = new WeakMap<SidebarEntry[], SidebarLink[]>();
+
 /** Get previous/next pages in the sidebar or the ones from the frontmatter if any. */
 export function getPrevNextLinks(
 	sidebar: SidebarEntry[],

package/utils/routing/index.ts

@@ -12,7 +12,6 @@ validateLogoImports();
 
 interface Path extends GetStaticPathsItem {
 	params: { slug: string | undefined };
-	props: Route;
 }
 
 /**
@@ -61,10 +60,10 @@ function getRoutes(): Route[] {
 			if (!localeConfig) continue;
 			const locale = key === 'root' ? undefined : key;
 			const localeDocs = getLocaleDocs(locale);
+			const localeDocIds = new Set(localeDocs.map(({ id }) => id));
 			for (const fallback of defaultLocaleDocs) {
 				const id = localizedSlug(fallback.id, locale);
-				const doesNotNeedFallback = localeDocs.some((doc) => doc.id === id);
-				if (doesNotNeedFallback) continue;
+				if (localeDocIds.has(id)) continue;
 				routes.push({
 					entry: fallback,
 					id,
@@ -82,6 +81,12 @@ function getRoutes(): Route[] {
 }
 export const routes = getRoutes();
 
+const routesById = new Map(routes.map((route) => [route.id, route]));
+
+export function getRouteById(id: string): Route | undefined {
+	return routesById.get(id);
+}
+
 function getParamRouteMapping(): ReadonlyMap<string | undefined, Route> {
 	const map = new Map<string | undefined, Route>();
 	for (const route of routes) {
@@ -98,7 +103,6 @@ export function getRouteBySlugParam(slugParam: string | undefined): Route | unde
 function getPaths(): Path[] {
 	return routes.map((route) => ({
 		params: { slug: slugToParam(route.id) },
-		props: route,
 	}));
 }
 export const paths = getPaths();