Init

2026-09-15 23:25:16 +00:00 · 2025-06-17 11:20:28 +02:00
1197 changed files with 23502 additions and 85508 deletions
@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Fix UX issue about highlighting the search term in search result sections
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Fix "View activity" disclosure in AI Chat not opening after the Base UI migration.
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Scroll to an in-page heading even when the URL hash is unchanged (e.g. clicking the same anchor again).
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Force software rendering (SwiftShader) in Playwright Chromium to eliminate image downscaling drift between GPU-equipped local runs and headless CI runs in Argos screenshots.
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Add an assistant tool to rate its own previous response when the user reacts to it.
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Add an assistant tool to submit feedback about the current page on behalf of the user.
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Assistant: you can now send follow-up questions while an answer is still being written. Each one appears as your own message with a "Queued" badge (hover for when it will send, × to cancel), and they're sent automatically one at a time as each answer completes.
@@ -0,0 +1,9 @@
+---
+"gitbook": patch
+---
+
+Fix three small visual issues
+
+- Fix sidebar showing on `no-toc` pages in the gradient theme
+- Fix variant selector truncating incorrectly in header when sections are present
+- Fix page cover alignment on `lg` screens without TOC
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Keep the breadcrumbs from covering the page actions' hit area.
@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Respect fullWidth and defaultWidth for images
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Move the incremental cache tier from the DO worker into the container worker.
@@ -1,5 +0,0 @@
---
-"gitbook": minor
---
-
-Add a carousel layout option to cards blocks, rendering them as a horizontally-scrolling, scroll-snapping row instead of a wrapping grid.
@@ -0,0 +1,5 @@
+---
+"gitbook-v2": patch
+---
+
+Add docs.testgitbook.com to ADAPTIVE_CONTENT_HOSTS list
@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+fix nested a tag causing hydration error
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Assistant: the "Explored briefly" activity heading no longer appears when there's nothing to show. It now renders only when the answer is preceded by a real preamble or one or more tool calls, so a simple answer with an empty reasoning step no longer surfaces an empty collapsible.
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Add a container server tier: an `@opennextjs/aws` node build of the app running inside a Cloudflare Container, reaching the cache worker through the container Durable Object's outbound handler. Build it with `bun run build:all` and run it locally with `bun run dev:cf:container`.
@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+fix href being empty in TOC
@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Fix navigation between sections/variants when previewing a site in v2
@@ -0,0 +1,5 @@
+---
+"gitbook": minor
+---
+
+Add support for inline icons.
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Deploy the container server tier from CI to preview, staging and production. Preview and staging serve their traffic from the container; production deploys it but keeps serving from the workerd tier.
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Fix host action buttons in the Docs Embed not reaching the assistant.
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Fix the docs embed `navigateToPage` API on multi-space sites. Deep-linking to a page in a different space/section (e.g. `navigateToPage('/help-center/integrations')`) previously 404'd because the section base was not placed before `~gitbook/embed/page`. The target is now resolved to its space server-side, so pages in any space resolve correctly. The input accepts the page path, an absolute path, or the full published URL.
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Fix suggested question clicks in the embed search not opening the assistant.
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Fix switching from the Search tab to the Docs or Assistant tab in the embed doing nothing.
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Add configurable default visibility to Prompt block
@@ -1,6 +0,0 @@
---
-"@gitbook/colors": patch
-"gitbook": patch
---
-
-A near-white tint color (e.g. a warm `#F5F3EF`) is now taken as the exact page background, mirroring the existing behavior for near-black tints. The tint's exact lightness, hue and chroma are preserved, and the color is anchored to whichever scale step the active theme renders as the background — so it matches exactly on `muted` (which uses the second step) as well as `clean`. This applies only to near-neutral tints that are light enough to read as a background; saturated or merely light-ish colors keep their normal accent scale. The `bold` theme is unaffected: it already uses the tint for the header and stays intentionally two-tone.
@@ -0,0 +1,5 @@
+---
+"gitbook": minor
+---
+
+Add circular corners and depth styling
@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Fix crash when integration script fails to render block.
@@ -1,7 +0,0 @@
---
-"gitbook": patch
---
-
-Introduce client-side content selection (`select`): a site-wide, recency-ordered list of selected slugs, persisted in localStorage and shareable via `?select=`, applied to `<html>` before first paint so the right variant renders with no flash. All variants stay server-rendered, so pages are byte-identical for every visitor (no cache impact).
-
-Tabs now use it: switching a tab activates its slug, and every tab group offering that slug follows, across pages. Tabs no longer write to the URL fragment (`#` returns to anchors only); deep-links into a tab still activate and scroll to it.
@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': patch
+---
+
+Add authorization header for OAuth2
@@ -1,7 +0,0 @@
---
-"@gitbook/openapi-parser": patch
-"@gitbook/react-openapi": patch
-"gitbook": patch
---
-
-Add missing link reference to OpenAPI models
@@ -0,0 +1,6 @@
+---
+'@gitbook/react-openapi': patch
+'gitbook': patch
+---
+
+Improve support for OAuth2 security type
@@ -0,0 +1,6 @@
+---
+"gitbook-v2": patch
+"gitbook": patch
+---
+
+Adds Columns layout block to GBO
@@ -0,0 +1,5 @@
+---
+"gitbook": minor
+---
+
+Support dark-mode specific page cover image
@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Update Models page styling
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Update the URL hash when a tab is selected, so a copied link scrolls back to that tab
@@ -0,0 +1,5 @@
+---
+"gitbook-v2": patch
+---
+
+Optimize performances by using a smarter per-request cache arround data cached functions
@@ -0,0 +1,5 @@
+---
+"gitbook-v2": patch
+---
+
+add a force-revalidate api route to force bust the cache in case of errors
@@ -0,0 +1,5 @@
+---
+"gitbook": minor
+---
+
+Fix rendering of ogimage with SVG logos.
@@ -0,0 +1,5 @@
+---
+"gitbook": minor
+---
+
+Best effort at preserving current variant when navigating between sections by matching the pathname against site spaces in the new section.
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Add cover image background mode and masks
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Button blocks now respect the `size` option, so you can render small, medium, or large buttons.
@@ -1,7 +0,0 @@
---
-"@gitbook/browser-types": patch
-"@gitbook/embed": patch
-"gitbook": patch
---
-
-Add an optional `context` property (string, up to 512 characters) to the `confirmation` of custom AI tools, shown above the confirmation dialog to help the user understand what they are approving or rejecting. The `confirmation` can now also be a function that receives the AI-provided input and returns the confirmation, so the context can be derived dynamically from the arguments the tool is about to run with. Available both to integrations (`GitBookIntegrationTool`) and to embed consumers (`GitBookToolDefinition`).
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Lazy-load the Mermaid code block so pages that have code blocks but no diagram no longer ship its rendering dependencies.
@@ -0,0 +1,6 @@
+---
+"gitbook-v2": patch
+"gitbook": patch
+---
+
+encode customization header
@@ -1,8 +0,0 @@
---
-"@gitbook/react-openapi": major
-"gitbook": patch
---
-
-Lazy load the Scalar API client modal and stop preloading the Scalar runtime. The modal is now code-split into its own chunk, fetched in parallel with the runtime only when a reader clicks "Test it", and a spinner is shown on the button until the client opens.
-
-Breaking: the package no longer ships the modal in its main entry — consumers must serve the emitted `ScalarApiModal` chunk and use a bundler that supports dynamic `import()`, and the Scalar runtime is no longer preloaded on page load. The internal `preloadScalarRuntime` helper is removed.
@@ -0,0 +1,5 @@
+---
+"gitbook": minor
+---
+
+Rework full-width layout, add support for full-width page option
@@ -1,5 +0,0 @@
---
-"gitbook": minor
---
-
-Add an `askQuestion` tool to the site MCP server. Alongside `searchDocumentation` and `getPage`, MCP clients can now ask a natural-language question and get a synthesized answer with links to the source pages, powered by the same AI search backend as the site's "ask a question" experience. The tool accepts an optional `goal` param so calling agents can attach the intent they're trying to accomplish, which tailors the answer and is tracked in analytics. The tool is only exposed on sites that have AI enabled.
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Submit `sendFeedback` MCP tool findings through the dedicated `submitSiteAgentFeedback` API endpoint. The `pageUrl` is now required and an optional `goal` can be provided.
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Mermaid diagrams no longer hijack page scrolling: zooming with the wheel now requires holding Ctrl/Cmd inline, while the fullscreen view keeps free wheel zoom.
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Migrate the headless UI primitives from Radix and react-aria to Base UI.
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Persist content selection (tabs and other `select` blocks) in localStorage only, dropping the `?select=` query parameter from the URL. A tab click still writes the tab's hash, so a copied URL lands on that tab and reactivates it on load.
@@ -0,0 +1,5 @@
+---
+"gitbook-v2": patch
+---
+
+fix ISR on preview env
@@ -0,0 +1,6 @@
+---
+"gitbook-v2": patch
+"gitbook": patch
+---
+
+Fix concurrent execution in Vercel causing pages to not be attached to the proper tags.
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Serve `X-Robots-Tag: noindex` on internal search/assistant URLs (`?q=` / `?ask=`) and stop disallowing them in robots.txt, so Google can crawl the directive and drop them from the index instead of reporting "Indexed, though blocked by robots.txt".
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Fix the variant switcher linking to the wrong URL for non-default variants of the default section
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Add an "On this page" table of contents on OpenAPI models pages. Each model in a grouped/multi-model "Models" section is now listed as its own section, matching operations and webhooks.
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Improve cookie handling in the OpenAPI "Test it" request proxy.
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Serve the OpenAPI "Test it" request proxy from GitBook's own domain.
@@ -1,6 +0,0 @@
---
-"gitbook": patch
-"@gitbook/react-openapi": minor
---
-
-Keep the OpenAPI renderer out of the initial bundle of pages that have no OpenAPI block, by building its context on the client behind a dynamic boundary.
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Fix OpenAPI webhook payload and schema example panels being clipped instead of scrollable.
@@ -0,0 +1,5 @@
+---
+"@gitbook/react-contentkit": patch
+---
+
+Add basic error handling when transitioning between states.
@@ -0,0 +1,5 @@
+---
+"gitbook-v2": patch
+---
+
+Generate a llms-full.txt version of the docs site
@@ -0,0 +1,5 @@
+---
+"@gitbook/fonts": minor
+---
+
+Initial version of the package
@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Fix rendering of ogimage when logo or icon are AVIF images.
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Align the Previous page navigation button to the left edge and the Next button to the right edge, including when only one of them is present.
@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Add margin to adjacent buttons
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Fix text disappearing in Firefox and iOS Safari on pages with a background cover
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Render a site-space custom home page at its placement root while preserving the full space and normal page URLs.
@@ -0,0 +1,5 @@
+---
+"gitbook-v2": patch
+---
+
+Don't cache unexpected API errors for more than a few minutes.
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Remove GBO's redundant re-selection of the best-scoring search section. The search API now returns a single highest-scoring section per page (and orders sections highest-score-first), so GBO no longer needs its own `getBestScoredResult` helper to pick the best section for the search and MCP previews. No user-visible change.
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Fix the docs embed not applying `?theme=light`/`?theme=dark`. The theme was dropped when the embed redirected to its default tab, and the embed tabs couldn't read it because they render statically (their request headers are empty). The middleware now threads a forced embed theme through the embed route context (scoped to the embed, not the main site), so the embed tabs honor it while staying statically rendered, and the redirect forwards it to the default tab. The forced theme is also persisted to the embed's own theme storage so it is remembered across tab navigation instead of only applying while the query string is present.
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Sync the API reference responses selector with the "Responses" collapsibles, and keep the selected response in sync across every operation on the page (like the code sample language selector). Selecting a status code now expands the matching response section and applies to all operations at once.
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Fix a light/dark flash on published sites configured to respect the system default (no theme toggle). Such sites forced the `system` theme, but `next-themes`' pre-paint script applies a forced value verbatim without resolving `prefers-color-scheme`, so the page painted light and only switched to dark after hydration. We now leave the theme unforced when the default is `system` (only concrete light/dark themes are forced), letting `next-themes`' existing pre-paint script resolve the system preference before first paint.
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Add a `sendFeedback` MCP tool so AI agents can report documentation findings (outdated / incoherent / gap / other) as `agent_feedback` insights events. The tool only accepts finding categories, so it never records positive feedback.
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Separate the prompt block actions into a primary "Open in" dropdown and a secondary "Copy prompt" button, instead of a single combined button group, and align the block's design with the expandable block (bordered frame, left disclosure chevron, and subtle elevation when expanded).
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Fix the docs embed widget shipping a stale script: declare the embed package's `standalone/` bundle as a Turbo build output. Because it wasn't declared, changes confined to the standalone widget (which compiles to `standalone/` but not `dist/`) didn't invalidate the downstream `generate` cache that copies it into the app, so the deployed widget could lag the source — e.g. the `clipboard-write` permission on the widget iframe never reached production, breaking the copy button in the Assistant embed.
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Fix code block syntax highlighting so comment delimiters (e.g. `//`, `/*`) use the same color as the rest of the comment. Previously the delimiter fell through to the generic punctuation scope, making it a different color from the comment body (most visible in dark mode).
@@ -0,0 +1,5 @@
+---
+"gitbook-v2": patch
+---
+
+add a global error boundary
@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': patch
+---
+
+Indent JSON python code sample
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Fix ScrollContainer scroll buttons not reflecting content overflow immediately or after dynamic content changes (e.g. search results).
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Fix the spacebar being ignored in the search bar, which made multi-word queries impossible.
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Keep the last search query visible after closing search, and restore it when reopening, without breaking navigation when clicking a search result.
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Link page-level search matches to the top of the page while preserving section anchors for section matches.
@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Fix missing title on button to close the announcement banner.
@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Make icons for page groups more contrasting
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Keep Shiki out of the initial page bundle by splitting the highlighter from the plain-text token helpers, so client code no longer pulls the engine and language bundles in through a shared import.
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Refine the per-paragraph AI ask button: shorten its tooltip to "Ask" (from "Ask <assistant> about this"), and hide it inside cards where it would otherwise be clipped by the card's overflow.
@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Ignore case while highlighting search results.
@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Make TOC height dynamic based on visible header and footer elements
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Split the default-scope site search into two parallel API requests — one restricted to the current site space and one for the other site spaces — rendering each result set as soon as its response arrives. All results are ranked together by score, with the current site space scores boosted.
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Keep the "On this page" and "Ask" buttons pinned below the header while scrolling on desktop API reference pages, so the page outline stays reachable throughout long operations.
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Hide unfocusable unlabelled button from screen readers
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Only show the "Back to [space]" shortcut for cross-space links in the table of contents, not for in-content text links or other ways of reaching another space.
@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Fix bold header links hover color
@@ -0,0 +1,6 @@
+---
+"gitbook": patch
+"gitbook-v2": patch
+---
+
+cache fonts and static image used in OGImage in memory
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Show image thumbnails, including SVG previews, for file attachments on published sites.
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Make the table search "no results" empty state more prominent with vertical spacing so it no longer blends into the content below.
@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Fix border being added to cards
@@ -1,5 +0,0 @@
---
-"gitbook": patch
---
-
-Fix heading anchor links being unreachable on touch devices by adding a tap-to-reveal state. The anchor icon now appears after the heading text without wrapping onto an orphan line while retaining its existing desktop placement. Use `pointerup` for the dismiss listener to fix unreliable dismissal on iOS Safari, and enlarge the anchor's touch tap target to a square 24px area (meeting the WCAG 2.5.8 minimum) so the icon stays centered instead of overflowing shorter headings' line height.
--- a/Show More
+++ b/Show More