@astrojs/starlight 0.9.0 → 0.10.0

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @astrojs/starlight
 
+## 0.10.0
+
+### Minor Changes
+
+- [#692](https://github.com/withastro/starlight/pull/692) [`2a58e1a`](https://github.com/withastro/starlight/commit/2a58e1aa068d01833a0ab9e74e4b46cccaee1775) Thanks [@delucis](https://github.com/delucis)! - Upgrade Pagefind to v1 and display page headings in search results
+
+### Patch Changes
+
+- [#708](https://github.com/withastro/starlight/pull/708) [`136cfb1`](https://github.com/withastro/starlight/commit/136cfb180f22db116cfdb62fd93d21daff596946) Thanks [@julien-deramond](https://github.com/julien-deramond)! - Fix main content column width for pages without a table of contents
+
+- [#682](https://github.com/withastro/starlight/pull/682) [`660a5f5`](https://github.com/withastro/starlight/commit/660a5f57adf0340de21df3e364aada38255bb06c) Thanks [@vedmalex](https://github.com/vedmalex)! - Add Russian language support
+
+## 0.9.1
+
+### Patch Changes
+
+- [#647](https://github.com/withastro/starlight/pull/647) [`ea57726`](https://github.com/withastro/starlight/commit/ea5772655274a3900310cb700836fdd2f6dba7cd) Thanks [@bgmort](https://github.com/bgmort)! - Fix translated 404 pages not being excluded from search results
+
+- [#667](https://github.com/withastro/starlight/pull/667) [`9828f73`](https://github.com/withastro/starlight/commit/9828f739b73e2f377c1450b9e11f0914722ee440) Thanks [@delucis](https://github.com/delucis)! - Break inline `<code>` across lines to avoid overflow
+
+- [#642](https://github.com/withastro/starlight/pull/642) [`e623d92`](https://github.com/withastro/starlight/commit/e623d92c2fddc0ff5fe83d2554266885d683a906) Thanks [@fk](https://github.com/fk)! - Don't hard-code nav height in table of contents highlighting script
+
+- [#676](https://github.com/withastro/starlight/pull/676) [`6419006`](https://github.com/withastro/starlight/commit/641900615aa9a9a128d6934e65a57ba89e503cfd) Thanks [@vedmalex](https://github.com/vedmalex)! - Upgrade and pin Pagefind to latest beta release.
+
+- [#647](https://github.com/withastro/starlight/pull/647) [`ea57726`](https://github.com/withastro/starlight/commit/ea5772655274a3900310cb700836fdd2f6dba7cd) Thanks [@bgmort](https://github.com/bgmort)! - Add frontmatter option to exclude a page from Pagefind search results
+
 ## 0.9.0
 
 ### Minor Changes

package/components/Search.astro

@@ -58,25 +58,28 @@ const pagefindTranslations = {
 			const dialog = this.querySelector('dialog')!;
 			const dialogFrame = this.querySelector('.dialog-frame')!;
 
-			/** Close the modal if a user clicks outside of the modal. */
-			const onWindowClick = (event: MouseEvent) => {
+			/** Close the modal if a user clicks on a link or outside of the modal. */
+			const onClick = (event: MouseEvent) => {
+				const isLink = 'href' in (event.target || {});
 				if (
-					document.body.contains(event.target as Node) &&
-					!dialogFrame.contains(event.target as Node)
-				)
+					isLink ||
+					(document.body.contains(event.target as Node) &&
+						!dialogFrame.contains(event.target as Node))
+				) {
 					closeModal();
+				}
 			};
 
 			const openModal = (event?: MouseEvent) => {
 				dialog.showModal();
 				this.querySelector('input')?.focus();
 				event?.stopPropagation();
-				window.addEventListener('click', onWindowClick);
+				window.addEventListener('click', onClick);
 			};
 
 			const closeModal = () => {
 				dialog.close();
-				window.removeEventListener('click', onWindowClick);
+				window.removeEventListener('click', onClick);
 			};
 
 			openBtn.addEventListener('click', openModal);
@@ -110,9 +113,10 @@ const pagefindTranslations = {
 					new PagefindUI({
 						element: '#starlight__search',
 						baseUrl: import.meta.env.BASE_URL,
-						bundlePath: import.meta.env.BASE_URL.replace(/\/$/, '') + '/_pagefind/',
+						bundlePath: import.meta.env.BASE_URL.replace(/\/$/, '') + '/pagefind/',
 						showImages: false,
 						translations,
+						showSubResults: true,
 					});
 				});
 			});
@@ -179,7 +183,7 @@ const pagefindTranslations = {
 	.dialog-frame {
 		flex-direction: column;
 		gap: 1rem;
-		padding: 1.5rem;
+		padding: 1rem;
 	}
 
 	button[data-close-modal] {
@@ -218,10 +222,31 @@ const pagefindTranslations = {
 			min-height: 15rem;
 			max-height: calc(100% - 8rem);
 		}
+
+		.dialog-frame {
+			padding: 1.5rem;
+		}
 	}
 </style>
 
 <style is:global>
+	#starlight__search {
+		--sl-search-result-spacing: calc(1.25rem * var(--pagefind-ui-scale));
+		--sl-search-result-pad-inline-start: calc(3.75rem * var(--pagefind-ui-scale));
+		--sl-search-result-pad-inline-end: calc(1.25rem * var(--pagefind-ui-scale));
+		--sl-search-result-pad-block: calc(0.9375rem * var(--pagefind-ui-scale));
+		--sl-search-result-nested-pad-block: calc(0.625rem * var(--pagefind-ui-scale));
+		--sl-search-corners: calc(0.3125rem * var(--pagefind-ui-scale));
+		--sl-search-page-icon-size: calc(1.875rem * var(--pagefind-ui-scale));
+		--sl-search-page-icon-inline-start: calc(
+			(var(--sl-search-result-pad-inline-start) - var(--sl-search-page-icon-size)) / 2
+		);
+		--sl-search-tree-diagram-size: calc(2.5rem * var(--pagefind-ui-scale));
+		--sl-search-tree-diagram-inline-start: calc(
+			(var(--sl-search-result-pad-inline-start) - var(--sl-search-tree-diagram-size)) / 2
+		);
+	}
+
 	#starlight__search .pagefind-ui__form::before {
 		--pagefind-ui-text: var(--sl-color-gray-1);
 		opacity: 1;
@@ -260,22 +285,36 @@ const pagefindTranslations = {
 	}
 
 	#starlight__search .pagefind-ui__results > * + * {
-		margin-top: 0.5rem;
+		margin-top: var(--sl-search-result-spacing);
 	}
 	#starlight__search .pagefind-ui__result {
-		position: relative;
 		border: 0;
-		border-radius: 0.25rem;
-		padding: 1rem;
+		padding: 0;
+	}
+
+	#starlight__search .pagefind-ui__result-nested {
+		position: relative;
+		padding: var(--sl-search-result-nested-pad-block) var(--sl-search-result-pad-inline-end);
+		padding-inline-start: var(--sl-search-result-pad-inline-start);
+	}
+
+	#starlight__search .pagefind-ui__result-title:not(:where(.pagefind-ui__result-nested *)),
+	#starlight__search .pagefind-ui__result-nested {
+		position: relative;
 		background-color: var(--sl-color-black);
 	}
 
-	#starlight__search .pagefind-ui__result:hover,
-	#starlight__search .pagefind-ui__result:focus-within {
+	#starlight__search .pagefind-ui__result-title:not(:where(.pagefind-ui__result-nested *)):hover,
+	#starlight__search
+		.pagefind-ui__result-title:not(:where(.pagefind-ui__result-nested *)):focus-within,
+	#starlight__search .pagefind-ui__result-nested:hover,
+	#starlight__search .pagefind-ui__result-nested:focus-within {
 		outline: 1px solid var(--sl-color-accent-high);
 	}
 
-	#starlight__search .pagefind-ui__result:focus-within {
+	#starlight__search
+		.pagefind-ui__result-title:not(:where(.pagefind-ui__result-nested *)):focus-within,
+	#starlight__search .pagefind-ui__result-nested:focus-within {
 		background-color: var(--sl-color-accent-low);
 	}
 
@@ -284,7 +323,37 @@ const pagefindTranslations = {
 		margin-top: 0;
 	}
 
+	#starlight__search .pagefind-ui__result-inner > :first-child {
+		border-radius: var(--sl-search-corners) var(--sl-search-corners) 0 0;
+	}
+	#starlight__search .pagefind-ui__result-inner > :last-child {
+		border-radius: 0 0 var(--sl-search-corners) var(--sl-search-corners);
+	}
+
+	#starlight__search .pagefind-ui__result-inner > .pagefind-ui__result-title {
+		padding: var(--sl-search-result-pad-block) var(--sl-search-result-pad-inline-end);
+		padding-inline-start: var(--sl-search-result-pad-inline-start);
+	}
+	#starlight__search .pagefind-ui__result-inner > .pagefind-ui__result-title::before {
+		content: '';
+		position: absolute;
+		inset-block: 0;
+		inset-inline-start: var(--sl-search-page-icon-inline-start);
+		width: var(--sl-search-page-icon-size);
+		background: var(--sl-color-gray-3);
+		-webkit-mask: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' fill='currentColor' viewBox='0 0 24 24'%3E%3Cpath d='M9 10h1a1 1 0 1 0 0-2H9a1 1 0 0 0 0 2Zm0 2a1 1 0 0 0 0 2h6a1 1 0 0 0 0-2H9Zm11-3V8l-6-6a1 1 0 0 0-1 0H7a3 3 0 0 0-3 3v14a3 3 0 0 0 3 3h10a3 3 0 0 0 3-3V9Zm-6-4 3 3h-2a1 1 0 0 1-1-1V5Zm4 14a1 1 0 0 1-1 1H7a1 1 0 0 1-1-1V5a1 1 0 0 1 1-1h5v3a3 3 0 0 0 3 3h3v9Zm-3-3H9a1 1 0 0 0 0 2h6a1 1 0 0 0 0-2Z'/%3E%3C/svg%3E")
+			center no-repeat;
+		mask: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' fill='currentColor' viewBox='0 0 24 24'%3E%3Cpath d='M9 10h1a1 1 0 1 0 0-2H9a1 1 0 0 0 0 2Zm0 2a1 1 0 0 0 0 2h6a1 1 0 0 0 0-2H9Zm11-3V8l-6-6a1 1 0 0 0-1 0H7a3 3 0 0 0-3 3v14a3 3 0 0 0 3 3h10a3 3 0 0 0 3-3V9Zm-6-4 3 3h-2a1 1 0 0 1-1-1V5Zm4 14a1 1 0 0 1-1 1H7a1 1 0 0 1-1-1V5a1 1 0 0 1 1-1h5v3a3 3 0 0 0 3 3h3v9Zm-3-3H9a1 1 0 0 0 0 2h6a1 1 0 0 0 0-2Z'/%3E%3C/svg%3E")
+			center no-repeat;
+	}
+
+	#starlight__search .pagefind-ui__result-inner {
+		align-items: stretch;
+		gap: 1px;
+	}
+
 	#starlight__search .pagefind-ui__result-link {
+		position: unset;
 		--pagefind-ui-text: var(--sl-color-white);
 		font-weight: 600;
 	}
@@ -293,6 +362,27 @@ const pagefindTranslations = {
 		text-decoration: none;
 	}
 
+	#starlight__search .pagefind-ui__result-nested .pagefind-ui__result-link::before {
+		content: unset;
+	}
+
+	#starlight__search .pagefind-ui__result-nested::before {
+		content: '';
+		position: absolute;
+		inset-block: 0;
+		inset-inline-start: var(--sl-search-tree-diagram-inline-start);
+		width: var(--sl-search-tree-diagram-size);
+		background: var(--sl-color-gray-4);
+		-webkit-mask: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' fill='none' stroke='currentColor' stroke-linecap='round' viewBox='0 0 16 1000' preserveAspectRatio='xMinYMin slice'%3E%3Cpath d='M8 0v1000m6-988H8'/%3E%3C/svg%3E")
+			0% 0% / 100% no-repeat;
+		mask: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' fill='none' stroke='currentColor' stroke-linecap='round' viewBox='0 0 16 1000' preserveAspectRatio='xMinYMin slice'%3E%3Cpath d='M8 0v1000m6-988H8'/%3E%3C/svg%3E")
+			0% 0% / 100% no-repeat;
+	}
+	#starlight__search .pagefind-ui__result-nested:last-child::before {
+		-webkit-mask-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' fill='none' stroke='currentColor' stroke-linecap='round' stroke-linejoin='round' viewBox='0 0 16 16'%3E%3Cpath d='M8 0v12m6 0H8'/%3E%3C/svg%3E");
+		mask-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' fill='none' stroke='currentColor' stroke-linecap='round' stroke-linejoin='round' viewBox='0 0 16 16'%3E%3Cpath d='M8 0v12m6 0H8'/%3E%3C/svg%3E");
+	}
+
 	#starlight__search .pagefind-ui__result-link::after {
 		content: '';
 		position: absolute;
@@ -300,18 +390,13 @@ const pagefindTranslations = {
 	}
 
 	#starlight__search .pagefind-ui__result-excerpt {
-		font-size: var(--sl-text-body-sm);
+		font-size: calc(1rem * var(--pagefind-ui-scale));
 		word-break: break-word;
 	}
 
 	#starlight__search mark {
-		color: var(--sl-color-white);
-		background-color: var(--sl-color-accent-low);
-		font-weight: 500;
-		padding: 0.1em 0.2em;
-	}
-
-	#starlight__search .pagefind-ui__result:focus-within mark {
-		text-decoration: underline;
+		color: var(--sl-color-gray-2);
+		background-color: transparent;
+		font-weight: 600;
 	}
 </style>

package/components/TableOfContents/MobileTableOfContents.astro

@@ -122,7 +122,7 @@ const t = useTranslations(locale);
 		}
 
 		constructor() {
-			super({ smallViewport: true });
+			super();
 			const details = this.querySelector('details');
 			if (!details) return;
 			const closeToC = () => {

package/components/TableOfContents/starlight-toc.ts

@@ -10,7 +10,7 @@ export class StarlightTOC extends HTMLElement {
 		this._current = link;
 	}
 
-	constructor({ smallViewport = false } = {}) {
+	constructor() {
 		super();
 
 		/** All the links in the table of contents. */
@@ -68,19 +68,13 @@ export class StarlightTOC extends HTMLElement {
 		// Also observe direct children of `.content` to include elements before
 		// the first heading.
 		const toObserve = document.querySelectorAll('main [id], main [id] ~ *, main .content > *');
-		/** Start intersections at nav height + 2rem padding. */
-		const top = (smallViewport ? 104 : 64) + 32;
-		/** End intersections 1.5rem later. */
-		const bottom = top + 24;
 
 		let observer: IntersectionObserver | undefined;
-		function observe() {
+		const observe = () => {
 			if (observer) observer.disconnect();
-			const height = document.documentElement.clientHeight;
-			const rootMargin = `-${top}px 0% ${bottom - height}px`;
-			observer = new IntersectionObserver(setCurrent, { rootMargin });
+			observer = new IntersectionObserver(setCurrent, { rootMargin: this.getRootMargin() });
 			toObserve.forEach((h) => observer!.observe(h));
-		}
+		};
 		observe();
 
 		const onIdle = window.requestIdleCallback || ((cb) => setTimeout(cb, 1));
@@ -92,6 +86,18 @@ export class StarlightTOC extends HTMLElement {
 			timeout = setTimeout(() => onIdle(observe), 200);
 		});
 	}
+
+	private getRootMargin(): `-${number}px 0% ${number}px` {
+		const navBarHeight = document.querySelector('header')?.getBoundingClientRect().height || 0;
+		// `<summary>` only exists in mobile ToC, so will fall back to 0 in large viewport component.
+		const mobileTocHeight = this.querySelector('summary')?.getBoundingClientRect().height || 0;
+		/** Start intersections at nav height + 2rem padding. */
+		const top = navBarHeight + mobileTocHeight + 32;
+		/** End intersections 1.5rem later. */
+		const bottom = top + 24;
+		const height = document.documentElement.clientHeight;
+		return `-${top}px 0% ${bottom - height}px`;
+	}
 }
 
 customElements.define('starlight-toc', StarlightTOC);

package/index.ts

@@ -68,7 +68,7 @@ export default function StarlightIntegration(opts: StarlightUserConfig): AstroIn
 				const cwd = dirname(fileURLToPath(import.meta.url));
 				const relativeDir = relative(cwd, targetDir);
 				return new Promise<void>((resolve) => {
-					spawn('npx', ['-y', 'pagefind', '--source', relativeDir], {
+					spawn('npx', ['-y', 'pagefind', '--site', relativeDir], {
 						stdio: 'inherit',
 						shell: true,
 						cwd,

package/layout/Page.astro

@@ -45,6 +45,8 @@ const tocConfig = !hasSidebar
 	: config.tableOfContents;
 const hasToC = Boolean(tocConfig);
 const hasHero = Boolean(entry.data.hero);
+const pagefindEnabled =
+	entry.slug !== '404' && !entry.slug.endsWith('/404') && entry.data.pagefind !== false;
 ---
 
 <html
@@ -91,7 +93,7 @@ const hasHero = Boolean(entry.data.hero);
 			{hasSidebar && <Sidebar slot="sidebar" {sidebar} {locale} />}
 			<TwoColumnContent {hasToC}>
 				<RightSidebar slot="right-sidebar" {headings} {locale} {tocConfig} />
-				<main data-pagefind-body={entry.slug !== '404'} lang={entryMeta.lang} dir={entryMeta.dir}>
+				<main data-pagefind-body={pagefindEnabled} lang={entryMeta.lang} dir={entryMeta.dir}>
 					{/* TODO: Revisit how this logic flows. */}
 					{entry.data.banner && <Banner {...entry.data.banner} />}
 					{

package/layout/TwoColumnContent.astro

@@ -46,7 +46,7 @@ interface Props {
 			width: 100%;
 		}
 
-		:global([data-has-sidebar]) .main-pane {
+		:global([data-has-sidebar][data-has-toc]) .main-pane {
 			--sl-content-margin-inline: auto 0;
 
 			order: 1;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astrojs/starlight",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "description": "Build beautiful, high-performance documentation websites with Astro",
   "keywords": [
     "docs",
@@ -39,13 +39,13 @@
   "dependencies": {
     "@astrojs/mdx": "^1.0.0",
     "@astrojs/sitemap": "^3.0.0",
-    "@pagefind/default-ui": "^1.0.0-alpha.5",
+    "@pagefind/default-ui": "^1.0.2",
     "@types/mdast": "^3.0.11",
     "bcp-47": "^2.1.0",
     "execa": "^7.1.1",
     "hast-util-select": "^5.0.5",
     "hastscript": "^7.2.0",
-    "pagefind": "^1.0.0-alpha.5",
+    "pagefind": "^1.0.2",
     "rehype": "^12.0.1",
     "remark-directive": "^2.0.1",
     "unified": "^10.1.2",

package/schema.ts

@@ -165,5 +165,8 @@ export function docsSchema() {
 					content: z.string(),
 				})
 				.optional(),
+
+			/** Pagefind indexing for this page - set to false to disable. */
+			pagefind: z.boolean().default(true),
 		});
 }

package/style/reset.css

@@ -38,7 +38,8 @@ h2,
 h3,
 h4,
 h5,
-h6 {
+h6,
+code {
 	overflow-wrap: break-word;
 }
 

package/translations/index.ts

@@ -16,11 +16,12 @@ import nb from './nb.json';
 import zh from './zh.json';
 import ko from './ko.json';
 import sv from './sv.json';
+import ru from './ru.json';
 
 const { parse } = builtinI18nSchema();
 
 export default Object.fromEntries(
-	Object.entries({ cs, en, es, de, ja, pt, fa, fr, it, nl, da, tr, ar, nb, zh, ko, sv }).map(
+	Object.entries({ cs, en, es, de, ja, pt, fa, fr, it, nl, da, tr, ar, nb, zh, ko, sv, ru }).map(
 		([key, dict]) => [key, parse(dict)]
 	)
 );

package/translations/ru.json

@@ -0,0 +1,22 @@
+{
+  "skipLink.label": "Пропустить до содержимого",
+  "search.label": "Поиск",
+  "search.shortcutLabel": "(Нажмите / для Поиска)",
+  "search.cancelLabel": "Отменить",
+  "search.devWarning": "Поиск доступен только в производственных сборках. \nПопробуйте выполнить сборку и просмотреть сайт, чтобы протестировать его локально.",
+  "themeSelect.accessibleLabel": "Выберите тему",
+  "themeSelect.dark": "Темная",
+  "themeSelect.light": "Светлая",
+  "themeSelect.auto": "Авто",
+  "languageSelect.accessibleLabel": "Выберите язык",
+  "menuButton.accessibleLabel": "Меню",
+  "sidebarNav.accessibleLabel": "Основное",
+  "tableOfContents.onThisPage": "На странице",
+  "tableOfContents.overview": "Обзор",
+  "i18n.untranslatedContent": "Этот содержимое пока не доступно на вашем языке.",
+  "page.editLink": "Редактировать странице",
+  "page.lastUpdated": "Последнее обновление:",
+  "page.previousLink": "Предыдущая",
+  "page.nextLink": "Следующая",
+  "404.text": "Страница не найдена. Проверьтье  URL или используйте поиск по сайту"
+}