@astrojs/starlight 0.34.1 → 0.34.3

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @astrojs/starlight
 
+## 0.34.3
+
+### Patch Changes
+
+- [#3058](https://github.com/withastro/starlight/pull/3058) [`274cc06`](https://github.com/withastro/starlight/commit/274cc06112824384771b944f504ab0faab45e2b9) Thanks [@techfg](https://github.com/techfg)! - Fixes display of focus indicator around site title
+
+- [#3181](https://github.com/withastro/starlight/pull/3181) [`449c822`](https://github.com/withastro/starlight/commit/449c8229effaab19ece3c0a34e32595809c33cc8) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Fixes an issue where all headings in Markdown and MDX content were rendered with a [clickable anchor link](https://starlight.astro.build/reference/configuration/#headinglinks), even in non-Starlight pages.
+
+- [#3168](https://github.com/withastro/starlight/pull/3168) [`ca693fe`](https://github.com/withastro/starlight/commit/ca693feb4b6aa9f26b3d536d284288773b788ac6) Thanks [@jsparkdev](https://github.com/jsparkdev)! - Updates Korean langage support with improvements and missing translations
+
+## 0.34.2
+
+### Patch Changes
+
+- [#3153](https://github.com/withastro/starlight/pull/3153) [`ea31f46`](https://github.com/withastro/starlight/commit/ea31f46be4d43339417dac7fc135d2be97080c58) Thanks [@SuperKXT](https://github.com/SuperKXT)! - Fixes hover styles for highlighted directory in FileTree component.
+
+- [#2905](https://github.com/withastro/starlight/pull/2905) [`b5232bc`](https://github.com/withastro/starlight/commit/b5232bcd201c2e3904bde2d7717fe6cfa06d6c82) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Fixes a potential issue for projects with dynamic routes added by an user, an Astro integration, or a Starlight plugin where some styles could end up being missing.
+
+- [#3165](https://github.com/withastro/starlight/pull/3165) [`80a7871`](https://github.com/withastro/starlight/commit/80a7871ccad17aef8567a416a419669de6d5d3fd) Thanks [@KianNH](https://github.com/KianNH)! - Increases `maxBuffer` for an internal `spawnSync()` call to support larger Git commit histories when using Starlight's [`lastUpdated`](https://starlight.astro.build/reference/configuration/#lastupdated) feature.
+
+- [#3158](https://github.com/withastro/starlight/pull/3158) [`d1f3c8b`](https://github.com/withastro/starlight/commit/d1f3c8b6583b93968af3c568f7af44b1b10326ec) Thanks [@heisenberg0924](https://github.com/heisenberg0924)! - Adds Hungarian language support
+
 ## 0.34.1
 
 ### Patch Changes

package/components/SiteTitle.astro

@@ -43,6 +43,10 @@ const { siteTitle, siteTitleHref } = Astro.locals.starlightRoute;
 			color: var(--sl-color-text-accent);
 			text-decoration: none;
 			white-space: nowrap;
+			min-width: 0;
+		}
+		span {
+			overflow: hidden;
 		}
 		img {
 			height: calc(var(--sl-nav-height) - 2 * var(--sl-nav-pad-y));

package/integrations/heading-links.ts

@@ -6,6 +6,7 @@ import { h } from 'hastscript';
 import type { Transformer } from 'unified';
 import { SKIP, visit } from 'unist-util-visit';
 import type { HookParameters, StarlightConfig } from '../types';
+import { resolveCollectionPath } from '../utils/collection';
 
 const AnchorLinkIcon = h(
 	'span',
@@ -24,10 +25,14 @@ const AnchorLinkIcon = h(
  * Add anchor links to headings.
  */
 export default function rehypeAutolinkHeadings(
-	useTranslationsForLang: HookParameters<'config:setup'>['useTranslations'],
-	absolutePathToLang: HookParameters<'config:setup'>['absolutePathToLang']
+	docsCollectionPath: string,
+	useTranslationsForLang: AutolinkHeadingsOptions['useTranslations'],
+	absolutePathToLang: AutolinkHeadingsOptions['absolutePathToLang']
 ) {
 	const transformer: Transformer<Root> = (tree, file) => {
+		// If the document is not part of the Starlight docs collection, skip it.
+		if (!normalizePath(file.path).startsWith(docsCollectionPath)) return;
+
 		const pageLang = absolutePathToLang(file.path);
 		const t = useTranslationsForLang(pageLang);
 
@@ -67,7 +72,9 @@ export default function rehypeAutolinkHeadings(
 
 interface AutolinkHeadingsOptions {
 	starlightConfig: Pick<StarlightConfig, 'markdown'>;
-	astroConfig: { experimental: Pick<AstroConfig['experimental'], 'headingIdCompat'> };
+	astroConfig: Pick<AstroConfig, 'srcDir'> & {
+		experimental: Pick<AstroConfig['experimental'], 'headingIdCompat'>;
+	};
 	useTranslations: HookParameters<'config:setup'>['useTranslations'];
 	absolutePathToLang: HookParameters<'config:setup'>['absolutePathToLang'];
 }
@@ -85,10 +92,24 @@ export const starlightAutolinkHeadings = ({
 					rehypeHeadingIds,
 					{ experimentalHeadingIdCompat: astroConfig.experimental?.headingIdCompat },
 				],
-				rehypeAutolinkHeadings(useTranslations, absolutePathToLang),
+				rehypeAutolinkHeadings(
+					normalizePath(resolveCollectionPath('docs', astroConfig.srcDir)),
+					useTranslations,
+					absolutePathToLang
+				),
 			]
 		: [];
 
+/**
+ * File path separators seems to be inconsistent on Windows when the rehype plugin is used on
+ * Markdown vs MDX files.
+ * For the time being, we normalize the path to unix style path.
+ */
+const backSlashRegex = /\\/g;
+function normalizePath(path: string) {
+	return path.replace(backSlashRegex, '/');
+}
+
 // This utility is inlined from https://github.com/syntax-tree/hast-util-heading-rank
 // Copyright (c) 2020 Titus Wormer <tituswormer@gmail.com>
 // MIT License: https://github.com/syntax-tree/hast-util-heading-rank/blob/main/license

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astrojs/starlight",
-  "version": "0.34.1",
+  "version": "0.34.3",
   "description": "Build beautiful, high-performance documentation websites with Astro",
   "keywords": [
     "docs",

package/routes/common.astro

@@ -1,9 +1,21 @@
 ---
+import { render } from 'astro:content';
 import Page from '../components/Page.astro';
-import { useRouteData } from '../utils/routing/data';
+import { getRoute, useRouteData } from '../utils/routing/data';
 import { attachRouteDataAndRunMiddleware } from '../utils/routing/middleware';
 
-await attachRouteDataAndRunMiddleware(Astro, await useRouteData(Astro));
+const route = await getRoute(Astro);
+/**
+ * The call to `render` from `astro:content` is purposely made in this file to work around a
+ * development mode head propagation issue which is heavily tied to `astro:content` imports. Even
+ * though we have a test for this, refactoring and moving this code to a different file should be
+ * avoided for now until the linked issue which also contains more details is resolved.
+ *
+ * @see https://github.com/withastro/astro/issues/13724
+ */
+const renderResult = await render(route.entry);
+
+await attachRouteDataAndRunMiddleware(Astro, await useRouteData(Astro, route, renderResult));
 
 const { Content, entry } = Astro.locals.starlightRoute;
 ---

package/translations/hu.json

@@ -0,0 +1,43 @@
+{
+  "skipLink.label": "Tovább a tartalomhoz",
+  "search.label": "Keresés",
+  "search.ctrlKey": "Ctrl",
+  "search.cancelLabel": "Mégsem",
+  "search.devWarning": "A keresés csak a production build-ekben működik. \nPróbáld meg először buildelni, hogy kipróbálhasd.",
+  "themeSelect.accessibleLabel": "Téma választás",
+  "themeSelect.dark": "Sötét",
+  "themeSelect.light": "Világos",
+  "themeSelect.auto": "Auto",
+  "languageSelect.accessibleLabel": "Nyelv választása",
+  "menuButton.accessibleLabel": "Menü",
+  "sidebarNav.accessibleLabel": "Fő",
+  "tableOfContents.onThisPage": "Ezen az oldalon",
+  "tableOfContents.overview": "Tartalom",
+  "i18n.untranslatedContent": "Ez a tartalom még nem érhető el a jelenlegi nyelven.",
+  "page.editLink": "Oldal szerkesztése",
+  "page.lastUpdated": "Utoljára frissítve:",
+  "page.previousLink": "Előző",
+  "page.nextLink": "Következő",
+  "page.draft": "Ez a tartalom még vázlat, így nem lesz benne a production build-ben.",
+  "404.text": "Az oldal nem található. Nézd meg az URL-t vagy használd a keresőt.",
+  "aside.note": "Megjegyzés",
+  "aside.tip": "Tipp",
+  "aside.caution": "Figyelem",
+  "aside.danger": "Veszély",
+  "fileTree.directory": "Könyvtár",
+  "builtWithStarlight.label": "Starlight-tal készítve",
+  "heading.anchorLabel": "Szekció neve “{{title}}”",
+  "expressiveCode.copyButtonCopied": "Másolva!",
+  "expressiveCode.copyButtonTooltip": "Másolás",
+  "expressiveCode.terminalWindowFallbackTitle": "Terminál",
+  "pagefind.clear_search": "Törlés",
+  "pagefind.load_more": "Több találat betöltése",
+  "pagefind.search_label": "Keresés ezen az oldalon",
+  "pagefind.filters_label": "Szűrők",
+  "pagefind.zero_results": "Erre a kifejezésre nincs találat: [SEARCH_TERM]",
+  "pagefind.many_results": "[COUNT] találat erre: [SEARCH_TERM]",
+  "pagefind.one_result": "[COUNT] találat erre: [SEARCH_TERM]",
+  "pagefind.alt_search": "Erre a kifejezésre nincs találat: [SEARCH_TERM]. Találatok mutatása erre: [DIFFERENT_TERM]",
+  "pagefind.search_suggestion": "Erre a kifejezésre nincs találat: [SEARCH_TERM]. Próbáld meg ezek közül az egyiket:",
+  "pagefind.searching": "Keresés erre: [SEARCH_TERM]..."
+}

package/translations/index.ts

@@ -29,6 +29,7 @@ import zhTW from './zh-TW.json';
 import pl from './pl.json';
 import sk from './sk.json';
 import lv from './lv.json';
+import hu from './hu.json';
 
 const { parse } = builtinI18nSchema();
 
@@ -64,5 +65,6 @@ export default Object.fromEntries(
 		pl,
 		sk,
 		lv,
+		hu,
 	}).map(([key, dict]) => [key, parse(dict)])
 );

package/translations/ko.json

@@ -1,30 +1,30 @@
 {
-  "skipLink.label": "컨텐츠로 건너뛰기",
+  "skipLink.label": "콘텐츠로 이동",
   "search.label": "검색",
   "search.ctrlKey": "Ctrl",
   "search.cancelLabel": "취소",
-  "search.devWarning": "검색 기능은 프로덕션 환경에서만 사용할 수 있습니다. \n사이트를 빌드하고 미리 보기를 실행하여 로컬에서 테스트하세요.",
+  "search.devWarning": "검색 기능은 프로덕션 빌드에서만 작동합니다. \n로컬에서 테스트하려면 사이트를 빌드하고 미리 보기를 실행하세요.",
   "themeSelect.accessibleLabel": "테마 선택",
-  "themeSelect.dark": "다크",
-  "themeSelect.light": "라이트",
+  "themeSelect.dark": "어두운 테마",
+  "themeSelect.light": "밝은 테마",
   "themeSelect.auto": "자동",
   "languageSelect.accessibleLabel": "언어 선택",
   "menuButton.accessibleLabel": "메뉴",
   "sidebarNav.accessibleLabel": "메인",
-  "tableOfContents.onThisPage": "이 페이지에서는",
+  "tableOfContents.onThisPage": "목차",
   "tableOfContents.overview": "개요",
-  "i18n.untranslatedContent": "이 콘텐츠는 아직 해당 언어로 제공되지 않습니다.",
-  "page.editLink": "페이지 수정",
+  "i18n.untranslatedContent": "이 콘텐츠는 아직 번역되지 않았습니다.",
+  "page.editLink": "페이지 편집",
   "page.lastUpdated": "마지막 업데이트:",
-  "page.previousLink": "이전",
-  "page.nextLink": "다음",
-  "page.draft": "이 콘텐츠는 초안이며 프로덕션 빌드에는 포함되지 않습니다.",
-  "404.text": "페이지를 찾을 수 없습니다. URL을 확인하거나 검색창을 사용해 보세요.",
-  "aside.note": "노트",
+  "page.previousLink": "이전 페이지",
+  "page.nextLink": "다음 페이지",
+  "page.draft": "이 콘텐츠는 아직 초안 상태이며, 최종 빌드에는 포함되지 않습니다.",
+  "404.text": "페이지를 찾을 수 없습니다. URL을 다시 확인해보거나 검색을 사용해보세요.",
+  "aside.note": "참고",
   "aside.tip": "팁",
   "aside.caution": "주의",
   "aside.danger": "위험",
   "fileTree.directory": "디렉터리",
-  "builtWithStarlight.label": "Starlight로 제작됨",
-  "heading.anchorLabel": "Section titled “{{title}}”"
+  "builtWithStarlight.label": "이 웹사이트는 Starlight로 제작되었습니다.",
+  "heading.anchorLabel": "섹션 제목: “{{title}}”"
 }

package/user-components/FileTree.astro

@@ -56,6 +56,7 @@ const html = processFileTree(fileTreeHtml, Astro.locals.t('fileTree.directory'))
 		}
 
 		starlight-file-tree :global(.directory > details > summary:hover .highlight .tree-icon) {
+			color: var(--sl-color-text-invert);
 			fill: currentColor;
 		}
 

package/utils/git.ts

@@ -72,6 +72,13 @@ export function getAllNewestCommitDate(rootPath: string, docsPath: string): [str
 		{
 			cwd: repoRoot,
 			encoding: 'utf-8',
+			// The default `maxBuffer` for `spawnSync` is 1024 * 1024 bytes, a.k.a 1 MB. In big projects,
+			// the full git history can be larger than this, so we increase this to ~10 MB. For example,
+			// Cloudflare passed 1 MB with ~4,800 pages and ~17,000 commits. If we get reports of others
+			// hitting ENOBUFS errors here in the future, we may want to switch to streaming the git log
+			// with `spawn` instead.
+			// See https://github.com/withastro/starlight/issues/3154
+			maxBuffer: 10 * 1024 * 1024,
 		}
 	);
 

package/utils/routing/data.ts

@@ -15,7 +15,7 @@ import type {
 import { formatPath } from '../format-path';
 import { useTranslations } from '../translations';
 import { BuiltInDefaultLocale } from '../i18n';
-import { getEntry, render } from 'astro:content';
+import { getEntry, type RenderResult } from 'astro:content';
 import { getCollectionPathFromRoot } from '../collection';
 import { getHead } from '../head';
 
@@ -25,11 +25,18 @@ export interface PageProps extends Route {
 
 export type RouteDataContext = Pick<APIContext, 'generator' | 'site' | 'url'>;
 
-export async function useRouteData(context: APIContext): Promise<StarlightRouteData> {
-	const route =
+export async function getRoute(context: APIContext): Promise<Route> {
+	return (
 		('slug' in context.params && getRouteBySlugParam(context.params.slug)) ||
-		(await get404Route(context.locals));
-	const { Content, headings } = await render(route.entry);
+		(await get404Route(context.locals))
+	);
+}
+
+export async function useRouteData(
+	context: APIContext,
+	route: Route,
+	{ Content, headings }: RenderResult
+): Promise<StarlightRouteData> {
 	const routeData = generateRouteData({ props: { ...route, headings }, context });
 	return { ...routeData, Content };
 }