Skip to content

Treat pages without visible TOC items as no-toc #3783

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 1 commit into from
Nov 5, 2025
+13 −1
Merged

Treat pages without visible TOC items as no-toc #3783

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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/slow-boxes-go.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"gitbook": patch
---

Treat pages without visible TOC items as `no-toc`
9 changes: 8 additions & 1 deletion packages/gitbook/src/components/PageBody/PageBody.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,11 @@ export function PageBody(props: {
const language = getSpaceLanguage(context);
const updatedAt = page.updatedAt ?? page.createdAt;

const hasVisibleTOCItems =
context.revision.pages.filter(
(page) => page.type !== 'document' || (page.type === 'document' && !page.hidden)
).length > 0;

return (
<CurrentPageProvider page={{ spaceId: context.space.id, pageId: page.id }}>
<main
Expand All @@ -56,7 +61,9 @@ export function PageBody(props: {
'break-anywhere',
pageWidthWide ? 'page-width-wide 3xl:px-8' : 'page-width-default',
siteWidthWide ? 'site-width-wide' : 'site-width-default',
page.layout.tableOfContents ? 'page-has-toc' : 'page-no-toc'
page.layout.tableOfContents && hasVisibleTOCItems
? 'page-has-toc'
: 'page-no-toc'
)}
>
<PreservePageLayout siteWidthWide={siteWidthWide} />
Expand Down