Pages without subheadings still display a table of contents

[alvinometric]

What version of starlight are you using?

latest

What is your idea?

Files that don't have headings display a table of contents with only "Overview."

This is a counter-intuitive behaviour, I don't think I've seen it anywhere else

Why is this feature necessary?

I think we should disable this, or at least let the user disable it via a config. If it's already possible then let's document this.

Do you have examples of this feature in other projects?

No response

Participation

• I am willing to submit a pull request for this feature.

[delucis]

(Sorry for the slow response on this one — still catching up after some time working on other projects.)

Interesting point — not something I’d run into before as I don’t think I’ve ever worked on a page without subheadings.

It is already possible to disable on a per-page basis using the tableOfContents frontmatter property:

---
title: Page with no table of contents
tableOfContents: false
---

So I guess this is about what should happen by default. Would you expect the entire right sidebar to vanish if there are no subheadings? Or keep the layout with the right sidebar but without the TOC?

[alvinometric]

Hello!

No worries, I'm glad to see PRs getting merged!

By default, I would expect no right sidebar if there is no subheading.

The sidebar I shared earlier with just one "Overview" that does nothing feels broken to me.