Skip to content

Move <summary> to top of <details> for validity #3423

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 18, 2025
Merged

Move <summary> to top of <details> for validity #3423

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d7964a9
Move <summary> to top of <details> for validity
andersk Sep 11, 2025
c14d654
Tweak changeset
delucis Sep 15, 2025
3075d7a
Move restore point back down below the `<summary>`
delucis Sep 18, 2025
a127aac
Tweak changeset (agan!)
delucis Sep 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/small-singers-smell.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@astrojs/starlight': patch
---

Fixes HTML validity in sidebar groups by ensuring `<summary>` is the first child of `<details>`
2 changes: 1 addition & 1 deletion packages/starlight/components/SidebarSublist.astro
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ const { sublist, nested } = Astro.props;
<details
open={flattenSidebar(entry.entries).some((i) => i.isCurrent) || !entry.collapsed}
>
<SidebarRestorePoint />
<summary>
<span class="group-label">
<span class="large">{entry.label}</span>
Expand All @@ -51,6 +50,7 @@ const { sublist, nested } = Astro.props;
</span>
<Icon name="right-caret" class="caret" size="1.25rem" />
</summary>
<SidebarRestorePoint />
Copy link
Member

@delucis delucis Sep 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And then remove it here:

Suggested change
<SidebarRestorePoint />

<Astro.self sublist={entry.entries} nested />
</details>
)}
Expand Down
Loading