@astrojs/starlight 0.38.0 → 0.38.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @astrojs/starlight
 
+## 0.38.1
+
+### Patch Changes
+
+- [#3751](https://github.com/withastro/starlight/pull/3751) [`fb955ff`](https://github.com/withastro/starlight/commit/fb955ff39c3244edf808495c557fb84ce2aab260) Thanks [@pyxelr](https://github.com/pyxelr)! - Fixes a regression causing global `tableOfContents` config to be ignored
+
 ## 0.38.0
 
 ### Minor Changes

package/package.json

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

package/schema.ts

@@ -2,7 +2,7 @@ import { z } from 'astro/zod';
 import type { SchemaContext } from 'astro:content';
 import { HeadConfigSchema } from './schemas/head';
 import { PrevNextLinkConfigSchema } from './schemas/prevNextLink';
-import { TableOfContentsSchema } from './schemas/tableOfContents';
+import { FrontmatterTableOfContentsSchema } from './schemas/tableOfContents';
 import { BadgeConfigSchema } from './schemas/badge';
 import { HeroSchema } from './schemas/hero';
 import { SidebarLinkItemHTMLAttributesSchema } from './schemas/sidebar';
@@ -33,7 +33,7 @@ const StarlightFrontmatterSchema = (context: SchemaContext) =>
 		head: HeadConfigSchema({ source: 'content' }),
 
 		/** Override global table of contents configuration for this page. */
-		tableOfContents: TableOfContentsSchema().optional(),
+		tableOfContents: FrontmatterTableOfContentsSchema(),
 
 		/**
 		 * Set the layout style for this page.

package/schemas/tableOfContents.ts

@@ -2,18 +2,20 @@ import { z } from 'astro/zod';
 
 const defaults = { minHeadingLevel: 2, maxHeadingLevel: 3 };
 
-export const TableOfContentsSchema = () =>
-	z
-		.union([
-			z.object({
-				/** The level to start including headings at in the table of contents. Default: 2. */
-				minHeadingLevel: z.int().min(1).max(6).optional().default(2),
-				/** The level to stop including headings at in the table of contents. Default: 3. */
-				maxHeadingLevel: z.int().min(1).max(6).optional().default(3),
-			}),
-			z.boolean().transform((enabled) => (enabled ? defaults : false)),
-		])
-		.default(defaults)
-		.refine((toc) => (toc ? toc.minHeadingLevel <= toc.maxHeadingLevel : true), {
-			error: 'minHeadingLevel must be less than or equal to maxHeadingLevel',
-		});
+const TableOfContentsBaseSchema = z
+	.union([
+		z.object({
+			/** The level to start including headings at in the table of contents. Default: 2. */
+			minHeadingLevel: z.int().min(1).max(6).optional().default(2),
+			/** The level to stop including headings at in the table of contents. Default: 3. */
+			maxHeadingLevel: z.int().min(1).max(6).optional().default(3),
+		}),
+		z.boolean().transform((enabled) => (enabled ? defaults : false)),
+	])
+	.refine((toc) => (toc ? toc.minHeadingLevel <= toc.maxHeadingLevel : true), {
+		error: 'minHeadingLevel must be less than or equal to maxHeadingLevel',
+	});
+
+export const UserConfigTableOfContentsSchema = () => TableOfContentsBaseSchema.default(defaults);
+
+export const FrontmatterTableOfContentsSchema = () => TableOfContentsBaseSchema.optional();

package/utils/user-config.ts

@@ -9,7 +9,7 @@ import { PagefindConfigDefaults, PagefindConfigSchema } from '../schemas/pagefin
 import { SidebarItemSchema } from '../schemas/sidebar';
 import { TitleConfigSchema, TitleTransformConfigSchema } from '../schemas/site-title';
 import { SocialLinksSchema } from '../schemas/social';
-import { TableOfContentsSchema } from '../schemas/tableOfContents';
+import { UserConfigTableOfContentsSchema } from '../schemas/tableOfContents';
 import { BuiltInDefaultLocale } from './i18n';
 
 const LocaleSchema = z.object({
@@ -49,7 +49,7 @@ const UserConfigSchema = z.object({
 	tagline: z.string().optional(),
 
 	/** Configure the defaults for the table of contents on each page. */
-	tableOfContents: TableOfContentsSchema(),
+	tableOfContents: UserConfigTableOfContentsSchema(),
 
 	/** Enable and configure “Edit this page” links. */
 	editLink: z