From 69732c6339472496554d7f484e01416b52cc142b Mon Sep 17 00:00:00 2001 From: Claire Chabas Date: Fri, 17 Oct 2025 19:04:28 +0200 Subject: [PATCH 1/2] Support new sidebar title page option --- .../src/components/TableOfContents/PageDocumentItem.tsx | 5 +++-- .../TableOfContents/encodeClientTableOfContents.ts | 2 ++ 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/packages/gitbook/src/components/TableOfContents/PageDocumentItem.tsx b/packages/gitbook/src/components/TableOfContents/PageDocumentItem.tsx index 13b3988873..970f708157 100644 --- a/packages/gitbook/src/components/TableOfContents/PageDocumentItem.tsx +++ b/packages/gitbook/src/components/TableOfContents/PageDocumentItem.tsx @@ -10,6 +10,7 @@ import { ToggleableLinkItem } from './ToggleableLinkItem'; export function PageDocumentItem(props: { page: ClientTOCPageDocument }) { const { page } = props; + const title = page.sidebarTitle || page.title; return (
  • @@ -41,10 +42,10 @@ export function PageDocumentItem(props: { page: ClientTOCPageDocument }) { {page.emoji || page.icon ? ( - {page.title} + {title} ) : ( - page.title + title )}
  • diff --git a/packages/gitbook/src/components/TableOfContents/encodeClientTableOfContents.ts b/packages/gitbook/src/components/TableOfContents/encodeClientTableOfContents.ts index 3c3820c3f0..470064b5d1 100644 --- a/packages/gitbook/src/components/TableOfContents/encodeClientTableOfContents.ts +++ b/packages/gitbook/src/components/TableOfContents/encodeClientTableOfContents.ts @@ -19,6 +19,7 @@ export type ClientTOCPageDocument = { type: 'document'; id: string; title: string; + sidebarTitle?: string; href: string; emoji?: string; icon?: string; @@ -73,6 +74,7 @@ export async function encodeClientTableOfContents( removeUndefined({ id: page.id, title: page.title, + sidebarTitle: page.sidebarTitle, href, emoji: page.emoji, icon: page.icon, From a620aafe2c8b867fc24c00b030f104e9c66180ed Mon Sep 17 00:00:00 2001 From: Claire Chabas Date: Mon, 10 Nov 2025 15:29:24 +0000 Subject: [PATCH 2/2] Update to use publishedTitle for the page title instead of linkTitle --- packages/gitbook/src/components/PDF/PDFPage.tsx | 6 ++++-- packages/gitbook/src/components/PageBody/PageHeader.tsx | 2 +- .../src/components/TableOfContents/PageDocumentItem.tsx | 5 ++--- .../TableOfContents/encodeClientTableOfContents.ts | 2 -- 4 files changed, 7 insertions(+), 8 deletions(-) diff --git a/packages/gitbook/src/components/PDF/PDFPage.tsx b/packages/gitbook/src/components/PDF/PDFPage.tsx index 3918283c14..f55c2c7502 100644 --- a/packages/gitbook/src/components/PDF/PDFPage.tsx +++ b/packages/gitbook/src/components/PDF/PDFPage.tsx @@ -212,7 +212,9 @@ async function PDFPageGroup(props: { space: Space; page: RevisionPageGroup }) { 'py-12' )} > -

    {page.title}

    +

    + {page.publishedTitle || page.title} +

    ); @@ -227,7 +229,7 @@ async function PDFPageDocument(props: { return ( -

    {page.title}

    +

    {page.publishedTitle || page.title}

    {page.description ? (

    {page.description}

    ) : null} diff --git a/packages/gitbook/src/components/PageBody/PageHeader.tsx b/packages/gitbook/src/components/PageBody/PageHeader.tsx index 2c5c6aedc6..61c6b969cb 100644 --- a/packages/gitbook/src/components/PageBody/PageHeader.tsx +++ b/packages/gitbook/src/components/PageBody/PageHeader.tsx @@ -115,7 +115,7 @@ export async function PageHeader(props: { )} > - {page.title} + {page.publishedTitle || page.title} ) : null} {page.description && page.layout.description ? ( diff --git a/packages/gitbook/src/components/TableOfContents/PageDocumentItem.tsx b/packages/gitbook/src/components/TableOfContents/PageDocumentItem.tsx index 970f708157..13b3988873 100644 --- a/packages/gitbook/src/components/TableOfContents/PageDocumentItem.tsx +++ b/packages/gitbook/src/components/TableOfContents/PageDocumentItem.tsx @@ -10,7 +10,6 @@ import { ToggleableLinkItem } from './ToggleableLinkItem'; export function PageDocumentItem(props: { page: ClientTOCPageDocument }) { const { page } = props; - const title = page.sidebarTitle || page.title; return (
  • @@ -42,10 +41,10 @@ export function PageDocumentItem(props: { page: ClientTOCPageDocument }) { {page.emoji || page.icon ? ( - {title} + {page.title} ) : ( - title + page.title )}
  • diff --git a/packages/gitbook/src/components/TableOfContents/encodeClientTableOfContents.ts b/packages/gitbook/src/components/TableOfContents/encodeClientTableOfContents.ts index 470064b5d1..3c3820c3f0 100644 --- a/packages/gitbook/src/components/TableOfContents/encodeClientTableOfContents.ts +++ b/packages/gitbook/src/components/TableOfContents/encodeClientTableOfContents.ts @@ -19,7 +19,6 @@ export type ClientTOCPageDocument = { type: 'document'; id: string; title: string; - sidebarTitle?: string; href: string; emoji?: string; icon?: string; @@ -74,7 +73,6 @@ export async function encodeClientTableOfContents( removeUndefined({ id: page.id, title: page.title, - sidebarTitle: page.sidebarTitle, href, emoji: page.emoji, icon: page.icon,