Ignore <script> elements when processing <Steps> (#3726)

delucis · web-flow · commit 8a09b60b03ae · 2026-02-25T14:24:47.000+01:00
diff --git a/.changeset/hip-experts-crash.md b/.changeset/hip-experts-crash.md
@@ -0,0 +1,5 @@
+---
+'@astrojs/starlight': patch
+---
+
+Fixes an issue using components containing scripts inside Starlight’s steps component in versions of Astro >= 5.16.9
diff --git a/packages/starlight/__tests__/remark-rehype/rehype-steps.test.ts b/packages/starlight/__tests__/remark-rehype/rehype-steps.test.ts
@@ -62,6 +62,17 @@ test('component with multiple children throws an error', () => {
 	`);
 });
 
+// This tests a workaround added for https://github.com/withastro/astro/issues/15627
+// See rehype-steps.ts for more details.
+test('component with top-level script child is processed successfully', () => {
+	const { html } = processSteps(
+		'<script type="module" src="/test-script.js"></script><ol><li>List item</li></ol>'
+	);
+	expect(html).toMatchInlineSnapshot(
+		`"<script type="module" src="/test-script.js"></script><ol role="list" class="sl-steps"><li>List item</li></ol>"`
+	);
+});
+
 test('applies `role="list"` to child list', () => {
 	const { html } = processSteps('<ol><li>Step one</li></ol>');
 	expect(html).toMatchInlineSnapshot(`"<ol role="list" class="sl-steps"><li>Step one</li></ol>"`);
diff --git a/packages/starlight/user-components/rehype-steps.ts b/packages/starlight/user-components/rehype-steps.ts
@@ -12,7 +12,16 @@ const stepsProcessor = rehype()
 	.data('settings', { fragment: true })
 	.use(function steps() {
 		return (tree: Root, vfile: VFile) => {
-			const rootElements = tree.children.filter((item): item is Element => item.type === 'element');
+			const rootElements = tree.children.filter(
+				(item): item is Element =>
+					item.type === 'element' &&
+					// Since Astro 5.16.9, `<script>` elements from nested child elements can end up hoisted
+					// into the `<Steps>` slot due to our use of `Astro.slots.render()`. We can safely ignore
+					// these, so we filter them out here.
+					// TODO: we may be able to remove this in the future if the upstream issue is fixed.
+					// See: https://github.com/withastro/astro/issues/15627
+					item.tagName !== 'script'
+			);
 			const [rootElement] = rootElements;
 
 			if (!rootElement) {

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@astrojs/starlight': patch
 +---
++
 +Fixes an issue using components containing scripts inside Starlight’s steps component in versions of Astro >= 5.16.9