@astrojs/starlight 0.8.1 → 0.9.1

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @astrojs/starlight
 
+## 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
+
+- [#626](https://github.com/withastro/starlight/pull/626) [`5dd22b8`](https://github.com/withastro/starlight/commit/5dd22b875dc19a32c48692082fbd934e2b70da63) Thanks [@delucis](https://github.com/delucis)! - Throw an error for duplicate MDX or sitemap integrations
+
+- [#615](https://github.com/withastro/starlight/pull/615) [`7b75b3e`](https://github.com/withastro/starlight/commit/7b75b3eb7e6f7870a0adef2d6534ff48309fdb0e) Thanks [@delucis](https://github.com/delucis)! - Bump minimum required Astro version to 3.0
+
+  ⚠️ **BREAKING CHANGE** Astro v2 is no longer supported. Make sure you [update Astro](https://docs.astro.build/en/guides/upgrade-to/v3/) and any other integrations at the same time as updating Starlight.
+
 ## 0.8.1
 
 ### Patch Changes

package/components/LastUpdated.astro

@@ -28,7 +28,7 @@ try {
 {
 	date && (
 		<p>
-			{t('page.lastUpdated')}
+			{t('page.lastUpdated')}{' '}
 			<time datetime={date.toISOString()}>
 				{date.toLocaleDateString(lang, { dateStyle: 'medium' })}
 			</time>

package/components/Search.astro

@@ -110,7 +110,7 @@ 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,
 					});

package/components/SidebarSublist.astro

@@ -21,10 +21,13 @@ interface Props {
 					>
 						<span>{entry.label}</span>
 						{entry.badge && (
-							<Badge
-								text={entry.badge.text}
-								variant={entry.isCurrent ? 'outline' : entry.badge.variant}
-							/>
+							<>
+								{' '}
+								<Badge
+									text={entry.badge.text}
+									variant={entry.isCurrent ? 'outline' : entry.badge.variant}
+								/>
+							</>
 						)}
 					</a>
 				) : (

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

@@ -7,7 +7,7 @@ import { starlightAsides } from './integrations/asides';
 import { starlightSitemap } from './integrations/sitemap';
 import { vitePluginStarlightUserConfig } from './integrations/virtual-user-config';
 import { errorMap } from './utils/error-map';
-import { StarlightConfigSchema, StarlightUserConfig } from './utils/user-config';
+import { StarlightConfigSchema, type StarlightUserConfig } from './utils/user-config';
 import { rehypeRtlCodeSupport } from './integrations/code-rtl-support';
 
 export default function StarlightIntegration(opts: StarlightUserConfig): AstroIntegration[] {
@@ -45,22 +45,30 @@ export default function StarlightIntegration(opts: StarlightUserConfig): AstroIn
 							// Configure Shiki theme if the user is using the default github-dark theme.
 							config.markdown.shikiConfig.theme !== 'github-dark' ? {} : { theme: 'css-variables' },
 					},
-					build: { inlineStylesheets: 'auto' },
-					experimental: {
-						assets: true,
-						// @ts-ignore - Needed for older versions of Astro, but an error since astro@2.6.0
-						inlineStylesheets: 'auto',
-					},
+					scopedStyleStrategy: 'where',
 				};
 				updateConfig(newConfig);
 			},
 
+			'astro:config:done': ({ config }) => {
+				const integrations = config.integrations.map(({ name }) => name);
+				for (const builtin of ['@astrojs/mdx', '@astrojs/sitemap']) {
+					if (integrations.filter((name) => name === builtin).length > 1) {
+						throw new Error(
+							`Found more than one instance of ${builtin}.\n` +
+								`Starlight includes ${builtin} by default.\n` +
+								'Please remove it from your integrations array in astro.config.mjs'
+						);
+					}
+				}
+			},
+
 			'astro:build:done': ({ dir }) => {
 				const targetDir = fileURLToPath(dir);
 				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/integrations/asides.ts

@@ -1,5 +1,5 @@
 import type { AstroUserConfig } from 'astro';
-import { h as _h, s as _s, Properties } from 'hastscript';
+import { h as _h, s as _s, type Properties } from 'hastscript';
 import type { Paragraph as P, Root } from 'mdast';
 import remarkDirective from 'remark-directive';
 import type { Plugin, Transformer } from 'unified';

package/integrations/sitemap.ts

@@ -1,4 +1,4 @@
-import sitemap, { SitemapOptions } from '@astrojs/sitemap';
+import sitemap, { type SitemapOptions } from '@astrojs/sitemap';
 import type { StarlightConfig } from '../types';
 
 /**

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astrojs/starlight",
-  "version": "0.8.1",
+  "version": "0.9.1",
   "description": "Build beautiful, high-performance documentation websites with Astro",
   "keywords": [
     "docs",
@@ -28,24 +28,24 @@
     "./404.astro": "./404.astro"
   },
   "peerDependencies": {
-    "astro": "^2.5.0"
+    "astro": "^3.0.0"
   },
   "devDependencies": {
     "@types/node": "^18.16.19",
     "@vitest/coverage-v8": "^0.33.0",
-    "astro": "^2.10.5",
+    "astro": "^3.0.6",
     "vitest": "^0.33.0"
   },
   "dependencies": {
-    "@astrojs/mdx": "^0.19.7",
-    "@astrojs/sitemap": "^1.3.3",
-    "@pagefind/default-ui": "^1.0.0-alpha.5",
+    "@astrojs/mdx": "^1.0.0",
+    "@astrojs/sitemap": "^3.0.0",
+    "@pagefind/default-ui": "1.0.0-beta.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.0-beta.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;
 }