@astrojs/starlight 0.26.4 → 0.27.0

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # @astrojs/starlight
 
+## 0.27.0
+
+### Minor Changes
+
+- [#1255](https://github.com/withastro/starlight/pull/1255) [`6f3202b`](https://github.com/withastro/starlight/commit/6f3202b3eb747de8a1cfcba001ab618d5fdee44a) Thanks [@Fryuni](https://github.com/Fryuni)! - Adds support for server-rendered Starlight pages.
+
+  When building a project with `hybrid` or `server` output mode, a new `prerender` option on Starlight config can be set to `false` to make all Starlight pages be rendered on-demand:
+
+  ```ts
+  export default defineConfig({
+    output: 'server',
+    integrations: [
+      starlight({
+        prerender: false,
+      }),
+    ],
+  });
+  ```
+
+### Patch Changes
+
+- [#2242](https://github.com/withastro/starlight/pull/2242) [`756e85e`](https://github.com/withastro/starlight/commit/756e85e8e814657c42c4a6f9c299b5bef32aee22) Thanks [@delucis](https://github.com/delucis)! - Refactors the logic for persisting and restoring sidebar state across navigations for better performance on slow or busy devices
+
+- [#1255](https://github.com/withastro/starlight/pull/1255) [`6f3202b`](https://github.com/withastro/starlight/commit/6f3202b3eb747de8a1cfcba001ab618d5fdee44a) Thanks [@Fryuni](https://github.com/Fryuni)! - Improves performance of computing the last updated times from Git history.
+
+  Instead of executing `git` for each docs page, it is now executed twice regardless of the number of pages.
+
+- [#1255](https://github.com/withastro/starlight/pull/1255) [`6f3202b`](https://github.com/withastro/starlight/commit/6f3202b3eb747de8a1cfcba001ab618d5fdee44a) Thanks [@Fryuni](https://github.com/Fryuni)! - Fixes last updated times on projects with custom `srcDir`
+
 ## 0.26.4
 
 ### Patch Changes

package/components/Sidebar.astro

@@ -2,46 +2,16 @@
 import type { Props } from '../props';
 
 import MobileMenuFooter from 'virtual:starlight/components/MobileMenuFooter';
-import { getSidebarHash } from '../utils/navigation';
+import SidebarPersister from './SidebarPersister.astro';
 import SidebarSublist from './SidebarSublist.astro';
 
 const { sidebar } = Astro.props;
-const hash = getSidebarHash(sidebar);
 ---
 
-<sl-sidebar-state-persist data-hash={hash}>
+<SidebarPersister {...Astro.props}>
 	<SidebarSublist sublist={sidebar} />
-</sl-sidebar-state-persist>
+</SidebarPersister>
+
 <div class="md:sl-hidden">
 	<MobileMenuFooter {...Astro.props} />
 </div>
-
-{
-	/*
-		Inline script to restore sidebar state as soon as possible.
-		- On smaller viewports, restoring state is skipped as the sidebar is collapsed inside a menu.
-		- The state is parsed from session storage and restored.
-		- This is a progressive enhancement, so any errors are swallowed silently.
-	*/
-}
-<script is:inline>
-	(() => {
-		try {
-			if (!matchMedia('(min-width: 50em)').matches) return;
-			const scroller = document.getElementById('starlight__sidebar');
-			/** @type {HTMLElement | null} */
-			const target = document.querySelector('sl-sidebar-state-persist');
-			const state = JSON.parse(sessionStorage.getItem('sl-sidebar-state') || '0');
-			if (!scroller || !target || !state || target.dataset.hash !== state.hash) return;
-			target
-				.querySelectorAll('details')
-				.forEach((el, idx) => typeof state.open[idx] === 'boolean' && (el.open = state.open[idx]));
-			scroller.scrollTop = state.scroll;
-		} catch {}
-	})();
-</script>
-<style>
-	sl-sidebar-state-persist {
-		display: contents;
-	}
-</style>

package/components/SidebarPersistState.ts

@@ -1,7 +1,6 @@
 // Collect required elements from the DOM.
 const scroller = document.getElementById('starlight__sidebar');
 const target = scroller?.querySelector<HTMLElement>('sl-sidebar-state-persist');
-const details = [...(target?.querySelectorAll('details') || [])];
 
 /** Starlight uses this key to store sidebar state in `sessionStorage`. */
 const storageKey = 'sl-sidebar-state';
@@ -58,8 +57,9 @@ target?.addEventListener('click', (event) => {
 	// This excludes clicks outside of the `<summary>`, which don’t trigger toggles.
 	const toggledDetails = event.target.closest('summary')?.closest('details');
 	if (!toggledDetails) return;
-	const index = details.indexOf(toggledDetails);
-	if (index === -1) return;
+	const restoreElement = toggledDetails.querySelector<HTMLElement>('sl-sidebar-restore');
+	const index = parseInt(restoreElement?.dataset.index || '');
+	if (isNaN(index)) return;
 	setToggleState(!toggledDetails.open, index);
 });
 

package/components/SidebarPersister.astro

@@ -0,0 +1,72 @@
+---
+/*
+  This component is designed to wrap the tree of `<SidebarSublist>` components in the sidebar.
+
+  It does the following:
+  - Wraps the tree in an `<sl-sidebar-state-persist>` custom element
+  - Before the tree renders, adds an inline script which loads state and defines
+  the behaviour for the `<sl-sidebar-restore>` custom element.
+  - After the tree renders, adds an inline script which restores the sidebar scroll state.
+
+  Notes:
+  - On smaller viewports, restoring state is skipped as the sidebar is collapsed inside a menu.
+  - The state is parsed from session storage and restored.
+  - This is a progressive enhancement, so any errors are swallowed silently.
+*/
+
+import type { Props } from '../props';
+import { getSidebarHash } from '../utils/navigation';
+
+const hash = getSidebarHash(Astro.props.sidebar);
+
+declare global {
+	interface Window {
+		/** Restored scroll position. Briefly stored on the `window` global to pass between inline scripts. */
+		_starlightScrollRestore?: number;
+	}
+}
+---
+
+<sl-sidebar-state-persist data-hash={hash}>
+	<script is:inline>
+		(() => {
+			try {
+				if (!matchMedia('(min-width: 50em)').matches) return;
+				/** @type {HTMLElement | null} */
+				const target = document.querySelector('sl-sidebar-state-persist');
+				const state = JSON.parse(sessionStorage.getItem('sl-sidebar-state') || '0');
+				if (!target || !state || target.dataset.hash !== state.hash) return;
+				window._starlightScrollRestore = state.scroll;
+				customElements.define(
+					'sl-sidebar-restore',
+					class SidebarRestore extends HTMLElement {
+						connectedCallback() {
+							try {
+								const idx = parseInt(this.dataset.index || '');
+								const details = this.closest('details');
+								if (details && typeof state.open[idx] === 'boolean') details.open = state.open[idx];
+							} catch {}
+						}
+					}
+				);
+			} catch {}
+		})();
+	</script>
+
+	<slot />
+
+	<script is:inline>
+		(() => {
+			const scroller = document.getElementById('starlight__sidebar');
+			if (!window._starlightScrollRestore || !scroller) return;
+			scroller.scrollTop = window._starlightScrollRestore;
+			delete window._starlightScrollRestore;
+		})();
+	</script>
+</sl-sidebar-state-persist>
+
+<style>
+	sl-sidebar-state-persist {
+		display: contents;
+	}
+</style>

package/components/SidebarRestorePoint.astro

@@ -0,0 +1,12 @@
+---
+/** Unique symbol for storing a running index in `locals`. */
+const currentGroupIndexSymbol = Symbol.for('starlight-sidebar-group-index');
+const locals = Astro.locals as Record<typeof currentGroupIndexSymbol, number>;
+
+/** The current sidebar group’s index retrieved from `locals` if set, starting at `0`. */
+const index = locals[currentGroupIndexSymbol] || 0;
+// Increment the index for the next instance.
+locals[currentGroupIndexSymbol] = index + 1;
+---
+
+<sl-sidebar-restore data-index={index}></sl-sidebar-restore>

package/components/SidebarSublist.astro

@@ -2,6 +2,7 @@
 import { flattenSidebar, type SidebarEntry } from '../utils/navigation';
 import Icon from '../user-components/Icon.astro';
 import Badge from '../user-components/Badge.astro';
+import SidebarRestorePoint from './SidebarRestorePoint.astro';
 
 interface Props {
 	sublist: SidebarEntry[];
@@ -35,6 +36,7 @@ const { sublist, nested } = Astro.props;
 					<details
 						open={flattenSidebar(entry.entries).some((i) => i.isCurrent) || !entry.collapsed}
 					>
+						<SidebarRestorePoint />
 						<summary>
 							<div class="group-label">
 								<span class="large">{entry.label}</span>

package/index.ts

@@ -50,17 +50,20 @@ export default function StarlightIntegration({
 				if (!starlightConfig.disable404Route) {
 					injectRoute({
 						pattern: '404',
-						entrypoint: '@astrojs/starlight/404.astro',
-						// Ensure page is pre-rendered even when project is on server output mode
-						prerender: true,
+						entrypoint: starlightConfig.prerender
+							? '@astrojs/starlight/routes/static/404.astro'
+							: '@astrojs/starlight/routes/ssr/404.astro',
+						prerender: starlightConfig.prerender,
 					});
 				}
 				injectRoute({
 					pattern: '[...slug]',
-					entrypoint: '@astrojs/starlight/index.astro',
-					// Ensure page is pre-rendered even when project is on server output mode
-					prerender: true,
+					entrypoint: starlightConfig.prerender
+						? '@astrojs/starlight/routes/static/index.astro'
+						: '@astrojs/starlight/routes/ssr/index.astro',
+					prerender: starlightConfig.prerender,
 				});
+
 				// Add built-in integrations only if they are not already added by the user through the
 				// config or by a plugin.
 				const allIntegrations = [...config.integrations, ...integrations];
@@ -73,6 +76,7 @@ export default function StarlightIntegration({
 				if (!allIntegrations.find(({ name }) => name === '@astrojs/mdx')) {
 					integrations.push(mdx({ optimize: true }));
 				}
+
 				// Add Starlight directives restoration integration at the end of the list so that remark
 				// plugins injected by Starlight plugins through Astro integrations can handle text and
 				// leaf directives before they are transformed back to their original form.
@@ -87,7 +91,7 @@ export default function StarlightIntegration({
 
 				updateConfig({
 					vite: {
-						plugins: [vitePluginStarlightUserConfig(starlightConfig, config)],
+						plugins: [vitePluginStarlightUserConfig(command, starlightConfig, config)],
 					},
 					markdown: {
 						remarkPlugins: [

package/integrations/virtual-user-config.ts

@@ -1,7 +1,8 @@
-import type { AstroConfig, ViteUserConfig } from 'astro';
+import type { AstroConfig, HookParameters, ViteUserConfig } from 'astro';
 import { resolve } from 'node:path';
 import { fileURLToPath } from 'node:url';
 import type { StarlightConfig } from '../utils/user-config';
+import { getAllNewestCommitDate } from '../utils/git';
 
 function resolveVirtualModuleId<T extends string>(id: T): `\0${T}` {
 	return `\0${id}`;
@@ -9,6 +10,7 @@ function resolveVirtualModuleId<T extends string>(id: T): `\0${T}` {
 
 /** Vite plugin that exposes Starlight user config and project context via virtual modules. */
 export function vitePluginStarlightUserConfig(
+	command: HookParameters<'astro:config:setup'>['command'],
 	opts: StarlightConfig,
 	{
 		build,
@@ -29,6 +31,8 @@ export function vitePluginStarlightUserConfig(
 	const resolveId = (id: string, base = root) =>
 		JSON.stringify(id.startsWith('.') ? resolve(fileURLToPath(base), id) : id);
 
+	const docsPath = resolve(fileURLToPath(srcDir), 'content/docs');
+
 	const virtualComponentModules = Object.fromEntries(
 		Object.entries(opts.components).map(([name, path]) => [
 			`virtual:starlight/components/${name}`,
@@ -45,6 +49,13 @@ export function vitePluginStarlightUserConfig(
 			srcDir,
 			trailingSlash,
 		})}`,
+		'virtual:starlight/git-info':
+			(command !== 'build'
+				? `import { makeAPI } from '${new URL('../utils/git.ts', import.meta.url)}';` +
+					`const api = makeAPI(${JSON.stringify(docsPath)});`
+				: `import { makeAPI } from '${new URL('../utils/gitInlined.ts', import.meta.url)}';` +
+					`const api = makeAPI(${JSON.stringify(getAllNewestCommitDate(docsPath))});`) +
+			'export const getNewestCommitDate = api.getNewestCommitDate;',
 		'virtual:starlight/user-css': opts.customCss.map((id) => `import ${resolveId(id)};`).join(''),
 		'virtual:starlight/user-images': opts.logo
 			? 'src' in opts.logo

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astrojs/starlight",
-  "version": "0.26.4",
+  "version": "0.27.0",
   "description": "Build beautiful, high-performance documentation websites with Astro",
   "keywords": [
     "docs",
@@ -162,8 +162,7 @@
       "types": "./integrations/expressive-code/hast.d.ts",
       "default": "./integrations/expressive-code/hast.mjs"
     },
-    "./index.astro": "./index.astro",
-    "./404.astro": "./404.astro",
+    "./routes/*": "./routes/*",
     "./style/markdown.css": "./style/markdown.css"
   },
   "peerDependencies": {
@@ -174,8 +173,9 @@
     "@playwright/test": "^1.45.0",
     "@types/node": "^18.16.19",
     "@vitest/coverage-v8": "^1.6.0",
-    "astro": "^4.10.2",
-    "vitest": "^1.6.0"
+    "astro": "^4.15.3",
+    "vitest": "^1.6.0",
+    "linkedom": "^0.18.4"
   },
   "dependencies": {
     "@astrojs/mdx": "^3.1.3",

package/routes/common.astro

@@ -0,0 +1,16 @@
+---
+import { generateRouteData } from '../utils/route-data';
+import type { Route } from '../utils/routing';
+import Page from '../components/Page.astro';
+
+export type Props = {
+	route: Route;
+};
+
+const { route } = Astro.props;
+
+const { Content, headings } = await route.entry.render();
+const routeData = generateRouteData({ props: { ...route, headings }, url: Astro.url });
+---
+
+<Page {...routeData}><Content frontmatter={route.entry.data} /></Page>

package/routes/ssr/404.astro

@@ -0,0 +1,7 @@
+---
+import FourOhFour from '../static/404.astro';
+
+export const prerender = false;
+---
+
+<FourOhFour />

package/routes/ssr/index.astro

@@ -0,0 +1,14 @@
+---
+import { getRouteBySlugParam } from '../../utils/routing';
+import CommonPage from '../common.astro';
+
+export const prerender = false;
+
+const route = getRouteBySlugParam(Astro.params.slug);
+
+if (route === undefined) {
+	return new Response(null, { status: 404 });
+}
+---
+
+<CommonPage route={route} />

package/{404.astro → routes/static/404.astro}

@@ -1,12 +1,11 @@
 ---
 import { getEntry } from 'astro:content';
 import config from 'virtual:starlight/user-config';
-import EmptyContent from './components/EmptyMarkdown.md';
-import Page from './components/Page.astro';
-import { generateRouteData } from './utils/route-data';
-import type { StarlightDocsEntry } from './utils/routing';
-import { useTranslations } from './utils/translations';
-import { BuiltInDefaultLocale } from './utils/i18n';
+import EmptyContent from '../../components/EmptyMarkdown.md';
+import type { Route, StarlightDocsEntry } from '../../utils/routing';
+import { useTranslations } from '../../utils/translations';
+import { BuiltInDefaultLocale } from '../../utils/i18n';
+import CommonPage from '../common.astro';
 
 export const prerender = true;
 
@@ -42,11 +41,7 @@ const fallbackEntry: StarlightDocsEntry = {
 
 const userEntry = await getEntry('docs', '404');
 const entry = userEntry || fallbackEntry;
-const { Content, headings } = await entry.render();
-const route = generateRouteData({
-	props: { ...entryMeta, entryMeta, headings, entry, id: entry.id, slug: entry.slug },
-	url: Astro.url,
-});
+const route: Route = { ...entryMeta, entryMeta, entry, id: entry.id, slug: entry.slug };
 ---
 
-<Page {...route}><Content /></Page>
+<CommonPage {route} />

package/routes/static/index.astro

@@ -0,0 +1,15 @@
+---
+import type { InferGetStaticPropsType } from 'astro';
+import { paths } from '../../utils/routing';
+import CommonPage from '../common.astro';
+
+export const prerender = true;
+
+export async function getStaticPaths() {
+	return paths;
+}
+
+type Props = InferGetStaticPropsType<typeof getStaticPaths>;
+---
+
+<CommonPage route={Astro.props} />

package/utils/git.ts

@@ -1,7 +1,22 @@
-import { basename, dirname } from 'node:path';
+/**
+ * Git module to be used from the dev server and from the integration.
+ */
+
+import { basename, dirname, relative, resolve } from 'node:path';
+import { realpathSync } from 'node:fs';
 import { spawnSync } from 'node:child_process';
 
-export function getNewestCommitDate(file: string) {
+export type GitAPI = {
+	getNewestCommitDate: (file: string) => Date;
+};
+
+export const makeAPI = (directory: string): GitAPI => {
+	return {
+		getNewestCommitDate: (file) => getNewestCommitDate(resolve(directory, file)),
+	};
+};
+
+export function getNewestCommitDate(file: string): Date {
 	const result = spawnSync('git', ['log', '--format=%ct', '--max-count=1', basename(file)], {
 		cwd: dirname(file),
 		encoding: 'utf-8',
@@ -22,3 +37,76 @@ export function getNewestCommitDate(file: string) {
 	const date = new Date(timestamp * 1000);
 	return date;
 }
+
+function getRepoRoot(directory: string): string {
+	const result = spawnSync('git', ['rev-parse', '--show-toplevel'], {
+		cwd: directory,
+		encoding: 'utf-8',
+	});
+
+	if (result.error) {
+		return directory;
+	}
+
+	try {
+		return realpathSync(result.stdout.trim());
+	} catch {
+		return directory;
+	}
+}
+
+export function getAllNewestCommitDate(directory: string): [string, number][] {
+	const repoRoot = getRepoRoot(directory);
+
+	const gitLog = spawnSync(
+		'git',
+		[
+			'log',
+			// Format each history entry as t:<seconds since epoch>
+			'--format=t:%ct',
+			// In each entry include the name and status for each modified file
+			'--name-status',
+			'--',
+			directory,
+		],
+		{
+			cwd: repoRoot,
+			encoding: 'utf-8',
+		}
+	);
+
+	if (gitLog.error) {
+		return [];
+	}
+
+	let runningDate = Date.now();
+	const latestDates = new Map<string, number>();
+
+	for (const logLine of gitLog.stdout.split('\n')) {
+		if (logLine.startsWith('t:')) {
+			// t:<seconds since epoch>
+			runningDate = Number.parseInt(logLine.slice(2)) * 1000;
+		}
+
+		// - Added files take the format `A\t<file>`
+		// - Modified files take the format `M\t<file>`
+		// - Deleted files take the format `D\t<file>`
+		// - Renamed files take the format `R<count>\t<old>\t<new>`
+		// - Copied files take the format `C<count>\t<old>\t<new>`
+		// The name of the file as of the commit being processed is always
+		// the last part of the log line.
+		const tabSplit = logLine.lastIndexOf('\t');
+		if (tabSplit === -1) continue;
+		const fileName = logLine.slice(tabSplit + 1);
+
+		const currentLatest = latestDates.get(fileName) || 0;
+		latestDates.set(fileName, Math.max(currentLatest, runningDate));
+	}
+
+	return Array.from(latestDates.entries()).map(([file, date]) => {
+		const fileFullPath = resolve(repoRoot, file);
+		const fileInDirectory = relative(directory, fileFullPath);
+
+		return [fileInDirectory, date];
+	});
+}

package/utils/gitInlined.ts

@@ -0,0 +1,20 @@
+/**
+ * Git module to be used on production build results.
+ * The API is based on inlined git information.
+ */
+
+import type { GitAPI, getAllNewestCommitDate } from './git';
+
+type InlinedData = ReturnType<typeof getAllNewestCommitDate>;
+
+export const makeAPI = (data: InlinedData): GitAPI => {
+	const trackedDocsFiles = new Map(data);
+
+	return {
+		getNewestCommitDate: (file) => {
+			const timestamp = trackedDocsFiles.get(file);
+			if (!timestamp) throw new Error(`Failed to retrieve the git history for file "${file}"`);
+			return new Date(timestamp);
+		},
+	};
+};

package/utils/plugins.ts

@@ -2,6 +2,7 @@ import type { AstroIntegration } from 'astro';
 import { z } from 'astro/zod';
 import { StarlightConfigSchema, type StarlightUserConfig } from '../utils/user-config';
 import { parseWithFriendlyErrors } from '../utils/error-map';
+import { AstroError } from 'astro/errors';
 
 /**
  * Runs Starlight plugins in the order that they are configured after validating the user-provided
@@ -72,6 +73,14 @@ export async function runPlugins(
 		});
 	}
 
+	if (context.config.output === 'static' && !starlightConfig.prerender) {
+		throw new AstroError(
+			'Starlight’s `prerender: false` option requires `output: "hybrid"` or `"server"` in your Astro config.',
+			'Either set `output` in your Astro config or set `prerender: true` in the Starlight options.\n\n' +
+				'Learn more about rendering modes in the Astro docs: https://docs.astro.build/en/basics/rendering-modes/'
+		);
+	}
+
 	return { integrations, starlightConfig };
 }
 

package/utils/route-data.ts

@@ -1,9 +1,8 @@
 import type { MarkdownHeading } from 'astro';
-import { fileURLToPath } from 'node:url';
 import project from 'virtual:starlight/project-context';
 import config from 'virtual:starlight/user-config';
 import { generateToC, type TocItem } from './generateToC';
-import { getNewestCommitDate } from './git';
+import { getNewestCommitDate } from 'virtual:starlight/git-info';
 import { getPrevNextLinks, getSidebar, type SidebarEntry } from './navigation';
 import { ensureTrailingSlash } from './path';
 import type { Route } from './routing';
@@ -82,11 +81,10 @@ function getLastUpdated({ entry }: PageProps): Date | undefined {
 	const { lastUpdated: configLastUpdated } = config;
 
 	if (frontmatterLastUpdated ?? configLastUpdated) {
-		const currentFilePath = fileURLToPath(new URL('src/content/docs/' + entry.id, project.root));
 		try {
 			return frontmatterLastUpdated instanceof Date
 				? frontmatterLastUpdated
-				: getNewestCommitDate(currentFilePath);
+				: getNewestCommitDate(entry.id);
 		} catch {
 			// If the git command fails, ignore the error.
 			return undefined;

package/utils/routing.ts

@@ -100,6 +100,19 @@ function getRoutes(): Route[] {
 }
 export const routes = getRoutes();
 
+function getParamRouteMapping(): ReadonlyMap<string | undefined, Route> {
+	const map = new Map<string | undefined, Route>();
+	for (const route of routes) {
+		map.set(slugToParam(route.slug), route);
+	}
+	return map;
+}
+const routesBySlugParam = getParamRouteMapping();
+
+export function getRouteBySlugParam(slugParam: string | undefined): Route | undefined {
+	return routesBySlugParam.get(slugParam?.replace(/\/$/, '') || undefined);
+}
+
 function getPaths(): Path[] {
 	return routes.map((route) => ({
 		params: { slug: slugToParam(route.slug) },

package/utils/user-config.ts

@@ -195,7 +195,7 @@ const UserConfigSchema = z.object({
 	 * Set to `false` to disable indexing your site with Pagefind.
 	 * This will also hide the default search UI if in use.
 	 */
-	pagefind: z.boolean().default(true),
+	pagefind: z.boolean().optional(),
 
 	/** Specify paths to components that should override Starlight’s default components */
 	components: ComponentConfigSchema(),
@@ -209,6 +209,13 @@ const UserConfigSchema = z.object({
 	/** Disable Starlight's default 404 page. */
 	disable404Route: z.boolean().default(false).describe("Disable Starlight's default 404 page."),
 
+	/**
+	 * Define whether Starlight pages should be prerendered or not.
+	 * Defaults to always prerender Starlight pages, even when the project is
+	 * set to "server" output mode.
+	 */
+	prerender: z.boolean().default(true),
+
 	/** Enable displaying a “Built with Starlight” link in your site’s footer. */
 	credits: z
 		.boolean()
@@ -216,8 +223,16 @@ const UserConfigSchema = z.object({
 		.describe('Enable displaying a “Built with Starlight” link in your site’s footer.'),
 });
 
-export const StarlightConfigSchema = UserConfigSchema.strict().transform(
-	({ title, locales, defaultLocale, ...config }, ctx) => {
+export const StarlightConfigSchema = UserConfigSchema.strict()
+	.transform((config) => ({
+		...config,
+		// Pagefind only defaults to true if prerender is also true.
+		pagefind: config.pagefind ?? config.prerender,
+	}))
+	.refine((config) => !(!config.prerender && config.pagefind), {
+		message: 'Pagefind search is not support with prerendering disabled.',
+	})
+	.transform(({ title, locales, defaultLocale, ...config }, ctx) => {
 		const configuredLocales = Object.keys(locales ?? {});
 
 		// This is a multilingual site (more than one locale configured) or a monolingual site with
@@ -286,8 +301,7 @@ export const StarlightConfigSchema = UserConfigSchema.strict().transform(
 			defaultLocale: defaultLocaleConfig,
 			locales: undefined,
 		} as const;
-	}
-);
+	});
 
 export type StarlightConfig = z.infer<typeof StarlightConfigSchema>;
 export type StarlightUserConfig = z.input<typeof StarlightConfigSchema>;

package/virtual.d.ts

@@ -14,6 +14,10 @@ declare module 'virtual:starlight/project-context' {
 	export default ProjectContext;
 }
 
+declare module 'virtual:starlight/git-info' {
+	export function getNewestCommitDate(file: string): Date;
+}
+
 declare module 'virtual:starlight/user-css' {}
 
 declare module 'virtual:starlight/user-images' {

package/index.astro

@@ -1,19 +0,0 @@
----
-import type { InferGetStaticPropsType } from 'astro';
-import { generateRouteData } from './utils/route-data';
-import { paths } from './utils/routing';
-
-import Page from './components/Page.astro';
-
-export const prerender = true;
-
-export async function getStaticPaths() {
-	return paths;
-}
-
-type Props = InferGetStaticPropsType<typeof getStaticPaths>;
-const { Content, headings } = await Astro.props.entry.render();
-const route = generateRouteData({ props: { ...Astro.props, headings }, url: Astro.url });
----
-
-<Page {...route}><Content frontmatter={Astro.props.entry.data} /></Page>