@astrojs/starlight 0.38.1 → 0.38.3

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @astrojs/starlight
 
+## 0.38.3
+
+### Patch Changes
+
+- [#3799](https://github.com/withastro/starlight/pull/3799) [`313611b`](https://github.com/withastro/starlight/commit/313611b1cd9c1f38688cb98cc103ddd758e80ec2) Thanks [@JosefJezek](https://github.com/JosefJezek)! - Improves Czech UI translations
+
+- [#3770](https://github.com/withastro/starlight/pull/3770) [`6e7bed1`](https://github.com/withastro/starlight/commit/6e7bed1e6b3b586b9719c620924f60d3678a1f83) Thanks [@gameroman](https://github.com/gameroman)! - Adds examples to the inline documentation for `title` in the Starlight configuration object
+
+- [#3801](https://github.com/withastro/starlight/pull/3801) [`fedd48b`](https://github.com/withastro/starlight/commit/fedd48b701ea9ca764b19139404c744099565f4c) Thanks [@delucis](https://github.com/delucis)! - Fixes missing draft content warning in dev on pages using the hero layout
+
+## 0.38.2
+
+### Patch Changes
+
+- [#3759](https://github.com/withastro/starlight/pull/3759) [`f24ce99`](https://github.com/withastro/starlight/commit/f24ce99a1a859920152e177f73afddce5c11902e) Thanks [@MilesChou](https://github.com/MilesChou)! - Fixes an issue where monolingual sites using a region-specific locale (e.g., `zh-TW`) as the default would incorrectly display base language translations (e.g., `zh` Simplified Chinese) instead of the region-specific ones (e.g., `zh-TW` Traditional Chinese).
+
+- [#3768](https://github.com/withastro/starlight/pull/3768) [`a4c6c20`](https://github.com/withastro/starlight/commit/a4c6c20e67c76caf1dfdb0c67b0fa1df15ef52b7) Thanks [@delucis](https://github.com/delucis)! - Improves performance of sidebar generation for sites with very large sidebars
+
 ## 0.38.1
 
 ### Patch Changes

package/components/ContentNotice.astro

@@ -28,6 +28,7 @@ const { icon, label } = Astro.props;
 			gap: 0.75em;
 			font-size: var(--sl-text-body-sm);
 			line-height: var(--sl-line-height-headings);
+			text-align: start;
 		}
 	}
 </style>

package/components/Hero.astro

@@ -1,5 +1,6 @@
 ---
 import { Image } from 'astro:assets';
+import DraftContentNotice from 'virtual:starlight/components/DraftContentNotice';
 import { PAGE_TITLE_ID } from '../constants';
 import LinkButton from '../user-components/LinkButton.astro';
 
@@ -44,6 +45,7 @@ if (image) {
 	<div class="sl-flex stack">
 		<div class="sl-flex copy">
 			<h1 id={PAGE_TITLE_ID} data-page-title set:html={title} />
+			{data.draft && <DraftContentNotice />}
 			{tagline && <div class="tagline" set:html={tagline} />}
 		</div>
 		{
@@ -67,6 +69,7 @@ if (image) {
 	@layer starlight.core {
 		.hero {
 			display: grid;
+			grid-template-columns: 100%;
 			align-items: center;
 			gap: 1rem;
 			padding-bottom: 1rem;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astrojs/starlight",
-  "version": "0.38.1",
+  "version": "0.38.3",
   "description": "Build beautiful, high-performance documentation websites with Astro",
   "keywords": [
     "docs",
@@ -47,10 +47,10 @@
   "devDependencies": {
     "@playwright/test": "^1.57.0",
     "@types/node": "^22.19.3",
-    "@vitest/coverage-v8": "^4.1.0-beta.6",
+    "@vitest/coverage-v8": "^4.1.0",
     "astro": "^6.0.1",
     "linkedom": "^0.18.4",
-    "vitest": "^4.1.0-beta.6"
+    "vitest": "^4.1.0"
   },
   "dependencies": {
     "@astrojs/markdown-remark": "^7.0.0",

package/translations/cs.json

@@ -15,19 +15,19 @@
   "tableOfContents.overview": "Přehled",
   "i18n.untranslatedContent": "Tento obsah zatím není dostupný ve vašem jazyce.",
   "page.editLink": "Upravit stránku",
-  "page.lastUpdated": "Poslední aktualizace:",
+  "page.lastUpdated": "Aktualizováno:",
   "page.previousLink": "Předchozí",
   "page.nextLink": "Další",
   "page.draft": "Tento obsah je koncept a nebude zahrnutý v produkčním sestavení.",
-  "404.text": "Stránka nenalezena. Zkontrolujte adresu nebo zkuste použít vyhledávač",
+  "404.text": "Stránka nenalezena. Zkontrolujte adresu nebo zkuste použít vyhledávač.",
   "aside.note": "Poznámka",
   "aside.tip": "Tip",
   "aside.caution": "Upozornění",
   "aside.danger": "Nebezpečí",
   "fileTree.directory": "Adresář",
-  "builtWithStarlight.label": "Postavené s Starlight",
+  "builtWithStarlight.label": "Postaveno se Starlight",
   "expressiveCode.copyButtonCopied": "Zkopírováno!",
-  "expressiveCode.copyButtonTooltip": "Kopíruj do schránky",
+  "expressiveCode.copyButtonTooltip": "Kopírovat do schránky",
   "expressiveCode.terminalWindowFallbackTitle": "Terminál",
   "pagefind.clear_search": "Vyčistit",
   "pagefind.load_more": "Načíst další výsledky",
@@ -39,5 +39,5 @@
   "pagefind.alt_search": "Žádné výsledky pro [SEARCH_TERM]. Namísto toho zobrazuji výsledky pro: [DIFFERENT_TERM]",
   "pagefind.search_suggestion": "Žádný výsledek pro [SEARCH_TERM]. Zkus nějaké z těchto hledání:",
   "pagefind.searching": "Hledám [SEARCH_TERM]...",
-  "heading.anchorLabel": "Section titled “{{title}}”"
+  "heading.anchorLabel": "Sekce “{{title}}”"
 }

package/utils/createTranslationSystem.ts

@@ -22,8 +22,7 @@ export async function createTranslationSystem<T extends i18nSchemaOutput>(
 
 	const translations = {
 		[defaultLocale]: buildResources(
-			builtinTranslations[defaultLocale],
-			builtinTranslations[stripLangRegion(defaultLocale)],
+			builtinTranslations[defaultLocale] || builtinTranslations[stripLangRegion(defaultLocale)],
 			pluginTranslations[defaultLocale],
 			userTranslations[defaultLocale]
 		),

package/utils/navigation.ts

@@ -357,14 +357,18 @@ function sidebarFromDir(
 
 /**
  * Intermediate sidebar represents sidebar entries generated from the user config for a specific
- * locale and do not contain any information about the current page.
- * These representations are cached per locale to avoid regenerating them for each page.
- * When generating the final sidebar for a page, the intermediate sidebar is cloned and the current
- * page is marked as such.
+ * locale. These representations are cached per locale to avoid regenerating them for each page.
+ * When generating the final sidebar for a page, the current page entry in the sidebar is marked
+ * with `isCurrent` and cached. Subsequent runs then reset the previous current entry before marking
+ * the new current page.
+ *
+ * Sidebars, like all route data, are deep cloned before the data is passed to users for mutation,
+ * so optimising with a single mutable object per locale is safe.
  *
  * @see getSidebarFromIntermediateSidebar
  */
 const intermediateSidebars = new Map<string | undefined, SidebarEntry[]>();
+const lastCurrentEntryByLocale = new Map<string | undefined, SidebarLink>();
 
 /** Get the sidebar for the current page using the global config. */
 export function getSidebar(pathname: string, locale: string | undefined): SidebarEntry[] {
@@ -373,7 +377,8 @@ export function getSidebar(pathname: string, locale: string | undefined): Sideba
 		intermediateSidebar = getIntermediateSidebarFromConfig(config.sidebar, pathname, locale);
 		intermediateSidebars.set(locale, intermediateSidebar);
 	}
-	return getSidebarFromIntermediateSidebar(intermediateSidebar, pathname);
+	setIntermediateSidebarCurrentEntry(intermediateSidebar, pathname, locale);
+	return intermediateSidebar;
 }
 
 /** Get the sidebar for the current page using the specified sidebar config. */
@@ -382,8 +387,10 @@ export function getSidebarFromConfig(
 	pathname: string,
 	locale: string | undefined
 ): SidebarEntry[] {
-	const intermediateSidebar = getIntermediateSidebarFromConfig(sidebarConfig, pathname, locale);
-	return getSidebarFromIntermediateSidebar(intermediateSidebar, pathname);
+	const sidebar = getIntermediateSidebarFromConfig(sidebarConfig, pathname, locale);
+	const currentEntry = getSidebarCurrentEntry(sidebar, pathname);
+	if (currentEntry) currentEntry.isCurrent = true;
+	return sidebar;
 }
 
 /** Get the intermediate sidebar for the current page using the specified sidebar config. */
@@ -401,32 +408,39 @@ function getIntermediateSidebarFromConfig(
 	}
 }
 
-/** Transform an intermediate sidebar into a sidebar for the current page. */
-function getSidebarFromIntermediateSidebar(
+/** Marks the current page in an intermediate sidebar. */
+function setIntermediateSidebarCurrentEntry(
 	intermediateSidebar: SidebarEntry[],
-	pathname: string
-): SidebarEntry[] {
-	const sidebar = structuredClone(intermediateSidebar);
-	setIntermediateSidebarCurrentEntry(sidebar, pathname);
-	return sidebar;
+	pathname: string,
+	locale: string | undefined
+): void {
+	// Reset the `isCurrent` flag in this sidebar if it was previously set.
+	const lastCurrentEntry = lastCurrentEntryByLocale.get(locale);
+	if (lastCurrentEntry) {
+		lastCurrentEntry.isCurrent = false;
+	}
+	// Find the new current entry.
+	const entry = getSidebarCurrentEntry(intermediateSidebar, pathname);
+	// Mark it as current and store it to be reset later.
+	if (entry) {
+		entry.isCurrent = true;
+		lastCurrentEntryByLocale.set(locale, entry);
+	}
 }
 
-/** Marks the current page as such in an intermediate sidebar. */
-function setIntermediateSidebarCurrentEntry(
-	intermediateSidebar: SidebarEntry[],
-	pathname: string
-): boolean {
-	for (const entry of intermediateSidebar) {
+/** 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)) {
-			entry.isCurrent = true;
-			return true;
+			return entry;
 		}
 
-		if (entry.type === 'group' && setIntermediateSidebarCurrentEntry(entry.entries, pathname)) {
-			return true;
+		if (entry.type === 'group') {
+			const currentEntry = getSidebarCurrentEntry(entry.entries, pathname);
+			if (currentEntry) return currentEntry;
 		}
 	}
-	return false;
+	return null;
 }
 
 /** Generates a deterministic string based on the content of the passed sidebar. */

package/utils/user-config.ts

@@ -22,7 +22,15 @@ const LocaleSchema = z.object({
 });
 
 const UserConfigSchema = z.object({
-	/** Title for your website. Will be used in metadata and as browser tab title. */
+	/**
+	 * Title for your website. Will be used in metadata and as browser tab title.
+	 *
+	 * @example
+	 * title: 'My Docs'
+	 *
+	 * @example
+	 * title: { en: 'My Docs' }
+	 */
 	title: TitleConfigSchema(),
 
 	/** Description metadata for your website. Can be used in page metadata. */