works

Co-authored-by: Steven Hall <steven@gitbook.io>

.bun-version

@@ -0,0 +1 @@
+1.1.40

.changeset/angry-lemons-greet.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix UI search without ask AI enabled and fix error with questions not returned from API

.changeset/angry-spies-appear.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix empty sitemap

.changeset/blue-baboons-exercise.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Adapt code to pull token from customer backend generated custom cookies

.changeset/breezy-days-pull.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix search no results error showing while there are results

.changeset/chilled-coats-punch.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Log component stack in Sentry

.changeset/chilled-kids-draw.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Reintroduce a safety check around search whilst we continue investigating caching.

.changeset/clever-mangos-explode.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Apply antialiasing on any text that are not code inline/blocks to avoid contrast issues

.changeset/clever-pumas-pump.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Handle security issue with cookies on Safari

.changeset/curly-apricots-happen.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Investigate an issue causing caches to return empty objects instead of null/undefined.

.changeset/curly-news-do.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': minor
+---
+
+Add an optional client context to get a callback called when the Scalar client is opened for a block.

.changeset/dirty-ties-brush.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix vertical section overflow color

.changeset/dull-goats-jam.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix pass Sentry release properly

.changeset/dull-melons-beam.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix shrinking page icons

.changeset/dull-parents-breathe.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Add support for sidebar background styles

.changeset/early-spiders-guess.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Start using tint in more places, TOC and PageAside

.changeset/eight-hounds-fry.md

@@ -0,0 +1,7 @@
+---
+'gitbook': patch
+---
+
+Ignore invalid API calls to `getSiteRedirectFromSource` API
+
+To reduce the load on the API and also avoid errors.

.changeset/eighty-poems-reflect.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Remove KV cache backend and only rely on DO as an external cache backend

.changeset/fair-frogs-fetch.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Ignore errors from event flushing

.changeset/few-rocks-film.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Simplify search results logic to investigate a bug

.changeset/fluffy-panthers-unite.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Try to fix error on og image generation

.changeset/forty-jars-fly.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Improve emoji setup, align with GitBook app

.changeset/fresh-lemons-pull.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Downgrade to Next.js v14 to fix incompatibilities with next-on-pages causing multiple bugs.

.changeset/fuzzy-crabs-argue.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Fix an issue where the redirects of potentially malicious images were not going through.

.changeset/giant-wolves-study.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix zoom image view transition on Safari

.changeset/gorgeous-horses-grow.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Position the variant picker in the ToC

.changeset/gorgeous-kiwis-check.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Make cookies access safer

.changeset/happy-emus-invite.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Handle Firefox security error on localStorage

.changeset/hip-comics-cross.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix errors from customization not found

.changeset/honest-teachers-enjoy.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Improve contrast of search box placeholder

.changeset/late-pots-remain.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix OG image generation for non-latin characters

.changeset/late-scissors-destroy.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Simplify the `useHash` algo used.

.changeset/lazy-beans-call.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Ignore cache invalidation error from local backend

.changeset/long-pumpkins-roll.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Track events for site insights using the new dedicated API.

.changeset/loud-files-tap.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Allow only good values for theme query parameter. Avoid having a 500 error when we pass an invalid value.

.changeset/mean-pears-live.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Improve colour contrast of list item decoration

.changeset/modern-walls-argue.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Set Sentry release

.changeset/moody-hairs-call.md

@@ -0,0 +1,6 @@
+---
+'@gitbook/react-openapi': minor
+'gitbook': minor
+---
+
+Revert scalar to 1.0.87 to mitigate an issue with ApiClientModalProvider

.changeset/nasty-apricots-wash.md

@@ -0,0 +1,6 @@
+---
+'@gitbook/react-contentkit': minor
+'gitbook': minor
+---
+
+Send redirectOnError param to getPublishedContent when token is pulled from cookie

.changeset/nasty-parents-sell.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Restyle PageAside to use sidebar list styles

.changeset/neat-donuts-teach.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-contentkit': patch
+---
+
+Fix potential invalid URL error in react-contentkit

.changeset/neat-pants-impress.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Avoid error on fetch by passing a string URL

.changeset/nice-spoons-double.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Fix an issue where search and Ask AI triggers unnecessary renders when in a Visitor Authenticated site.

.changeset/nine-gorillas-turn.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Track clicks on links (header, footer, content) for site insights.

.changeset/orange-chicken-develop.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix code format overriding inline link styles

.changeset/perfect-boxes-grow.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix emojis display

.changeset/perfect-laws-pay.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix server actions stability leading to no results found sometimes on search

.changeset/popular-feet-bake.md

@@ -0,0 +1,7 @@
+---
+'gitbook': patch
+---
+
+Implement a safer way to interact with localStorage.
+
+If it's disabled on the browser it should not throw error.

.changeset/pretty-elephants-glow.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix search UI behaviour

.changeset/pretty-penguins-carry.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix two issues where pages would crash due Recoil not behaving correctly in RSC.

.changeset/quiet-oranges-provide.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix dynamic tabs infinite loop

.changeset/quiet-zoos-applaud.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': patch
+---
+
+Prevent codemirror from loading multiple versions in scalar

.changeset/rich-impalas-applaud.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix error when accessing a change request not found

.changeset/serious-dancers-clean.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix variant selector contrast for non-default themes

.changeset/seven-hounds-grow.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix issue leading to increase the storage write and the stability of the platform

.changeset/shiny-cheetahs-grow.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Force route handler to be dynamic to avoid errors

.changeset/shiny-seahorses-explode.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': patch
+---
+
+Updated scalar depdenency

.changeset/silly-books-enjoy.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix search loading state

.changeset/spicy-mugs-eat.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix Sentry instrumentation

.changeset/strange-hornets-trade.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Even safer localStorage

.changeset/stupid-beans-travel.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Avoid errors on legacy browsers

.changeset/sweet-tools-fly.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Add antialiasing for text rendering

.changeset/tame-worms-march.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Improve readability of tables with hover style and vertical dividers

.changeset/tasty-cooks-kneel.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Improve styling of header buttons with shadows and high-contrast styles

.changeset/tasty-rocks-matter.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix viewing PDF from space

.changeset/tender-bags-guess.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Image optimization endpoint redirects to underlying image URL if the signature is not the latest.

.changeset/thick-ears-reply.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix bullet list display on full size blocks

.changeset/thick-items-sneeze.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Vertical orientation for sections list on sites without header

.changeset/thirty-berries-bow.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix error when accessing some not found pages.

.changeset/three-sloths-taste.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix "Parser" language syntax highlighting

.changeset/twelve-books-dream.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Fix a vulnerability issue for images using an older version of the image signing parameter.

.changeset/twelve-doors-film.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Track an event into site insights when visitor is opening the Scalar API client.

.changeset/twenty-rocks-tickle.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Upgrade Next.js to v15, upgrade Shiki and use JS RegExp engine

.changeset/two-beans-smell.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix breadcrumbs emoji display + add contrast styles

.changeset/two-mirrors-move.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix server actions cache compromised. Leading to some bugs on frontend.

.changeset/violet-parents-marry.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Improve smoothness of scroll listener

.changeset/wicked-apricots-drop.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix variant dropdown styling in header

.changeset/wild-chicken-matter.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix view transition error on Safari

.changeset/wild-lemons-camp.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Bump `heading-3` font size to offset it from paragraphs

.changeset/wise-otters-hear.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix Sentry instrumentation server-side

.changeset/yellow-singers-walk.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Remove animation on section tabs. Page is reloaded (for technical reasons), so the animation is not accurate here.

.github/actions/setup-playwright/action.yml

@@ -12,7 +12,7 @@ runs:
 
         # Cache browser binaries, cache key is based on Playwright version and OS
         - name: 🧰 Cache Playwright browser binaries
-          uses: actions/cache@v3
+          uses: actions/cache@v4
           id: playwright-cache
           with:
               path: '~/.cache/ms-playwright'

.github/composite/setup-bun/action.yaml

@@ -0,0 +1,18 @@
+name: 'Setup Bun'
+description: 'Install Bun and cache dependencies'
+runs:
+    using: 'composite'
+    steps:
+        # We cache dependencies even if Bun is fast to avoid downloading fontawesome too many times
+        # and impacting bandwidth there.
+        - name: Cache bun
+          uses: actions/cache@v4
+          with:
+              path: ~/.bun/install/cache
+              key: ${{ runner.os }}-bun-${{ hashFiles('**/bun.lockb') }}-${{ hashFiles('**/bun.lock') }}
+              restore-keys: |
+                  ${{ runner.os }}-bun-
+        - name: Setup bun
+          uses: oven-sh/setup-bun@v2
+          with:
+              bun-version-file: '.bun-version'

.github/workflows/ci.yaml

@@ -5,7 +5,7 @@ on:
         branches:
             - main
 env:
-    NPMRC_FONT_AWESOME_TOKEN: ${{ secrets.NPMRC_FONT_AWESOME_TOKEN }}
+    NPM_TOKEN_READONLY: ${{ secrets.NPM_TOKEN_READONLY }}
 jobs:
     deploy:
         name: Deploy to Cloudflare Pages
@@ -18,28 +18,16 @@ jobs:
             checks: write
             statuses: write
         outputs:
-            deployment_url: ${{ steps.deploy.outputs.url }}
+            deployment_url: ${{ steps.deploy.outputs.deployment-url }}
         steps:
             - name: Checkout
               uses: actions/checkout@v4
-            - name: Setup bun
-              uses: oven-sh/setup-bun@v1
-              with:
-                  bun-version: 1.1.18
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
             - name: Install dependencies
               run: bun install --frozen-lockfile
               env:
                   PUPPETEER_SKIP_DOWNLOAD: 1
-            - name: Cache Next.js build
-              uses: actions/cache@v3
-              with:
-                  path: |
-                      ${{ github.workspace }}/.next/cache
-                  # Generate a new cache whenever packages or source files change.
-                  key: ${{ runner.os }}-nextjs-${{ hashFiles('**/bun.lockb') }}-${{ hashFiles('**/*.js', '**/*.jsx', '**/*.ts', '**/*.tsx') }}
-                  # If source files changed but packages didn't, rebuild from a prior cache.
-                  restore-keys: |
-                      ${{ runner.os }}-nextjs-${{ hashFiles('**/bun.lockb') }}-
             - name: Sets env vars for production
               run: |
                   echo "SENTRY_ENVIRONMENT=production" >> $GITHUB_ENV
@@ -53,12 +41,14 @@ jobs:
               run: bun run build:cloudflare
               env:
                   SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
+                  NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: ${{ secrets.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY }}
                   SENTRY_ORG: ${{ vars.SENTRY_ORG }}
                   SENTRY_PROJECT: ${{ vars.SENTRY_PROJECT }}
                   SENTRY_DSN: ${{ vars.SENTRY_DSN }}
+                  SENTRY_RELEASE: ${{ github.sha }}
             - id: deploy
               name: Deploy to Cloudflare
-              uses: cloudflare/wrangler-action@v3
+              uses: cloudflare/wrangler-action@v3.11.0
               with:
                   apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
                   accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
@@ -67,7 +57,7 @@ jobs:
                   command: pages deploy ./packages/gitbook/.vercel/output/static --project-name=${{ vars.CLOUDFLARE_PROJECT_NAME }} --branch=${{ github.ref == 'refs/heads/main' && 'main' || format('pr{0}', github.event.pull_request.number) }}
             - name: Outputs
               run: |
-                  echo "URL: ${{ steps.deploy.outputs.url }}"
+                  echo "URL: ${{ steps.deploy.outputs.deployment-url }}"
                   echo "Alias URL: ${{ steps.deploy.outputs.deployment-alias-url }}"
             - name: Archive build output
               uses: actions/upload-artifact@v4
@@ -77,12 +67,12 @@ jobs:
             # Until https://github.com/cloudflare/wrangler-action/issues/301 is done
             - name: Update Deployment Status to Success
               env:
-                  DEPLOYMENT_URL: ${{ steps.deploy.outputs.url }}
+                  DEPLOYMENT_URL: ${{ steps.deploy.outputs.deployment-url }}
               run: |
                   curl -X POST \
                     -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
                     -H "Accept: application/vnd.github.v3+json" \
-                    -d '{"state": "success", "target_url": "${{ steps.deploy.outputs.url }}", "description": "Deployed Preview URL for commit", "context": "cloudflare/preview"}' \
+                    -d '{"state": "success", "target_url": "${{ steps.deploy.outputs.deployment-url }}", "description": "Deployed Preview URL for commit", "context": "cloudflare/preview"}' \
                     https://api.github.com/repos/${{ github.repository }}/statuses/${{ github.sha }}
 
             - name: Find GitHub Comment
@@ -102,8 +92,8 @@ jobs:
                   issue-number: ${{ github.event.pull_request.number }}
                   body: |
                       **GitBook Preview**
-                      Latest commit: [${{ steps.deploy.outputs.url }}](${{ steps.deploy.outputs.url }})
-                      PR: [${{ steps.deploy.outputs.alias }}](${{ steps.deploy.outputs.alias }})
+                      Latest commit: [${{ steps.deploy.outputs.deployment-url }}](${{ steps.deploy.outputs.deployment-url }})
+                      PR: [${{ steps.deploy.outputs.deployment-alias-url }}](${{ steps.deploy.outputs.deployment-alias-url }})
                   edit-mode: replace
     visual-testing:
         runs-on: ubuntu-latest
@@ -112,10 +102,8 @@ jobs:
         steps:
             - name: Checkout
               uses: actions/checkout@v4
-            - name: Setup bun
-              uses: oven-sh/setup-bun@v1
-              with:
-                  bun-version: 1.1.18
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
             - name: Install dependencies
               run: bun install --frozen-lockfile
             - name: Setup Playwright
@@ -138,10 +126,8 @@ jobs:
         steps:
             - name: Checkout
               uses: actions/checkout@v4
-            - name: Setup bun
-              uses: oven-sh/setup-bun@v1
-              with:
-                  bun-version: 1.1.18
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
             - name: Install dependencies
               run: bun install --frozen-lockfile
               env:
@@ -157,10 +143,8 @@ jobs:
         steps:
             - name: Checkout
               uses: actions/checkout@v4
-            - name: Setup bun
-              uses: oven-sh/setup-bun@v1
-              with:
-                  bun-version: 1.1.18
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
             - name: Install dependencies
               run: bun install --frozen-lockfile
               env:
@@ -172,10 +156,8 @@ jobs:
         steps:
             - name: Checkout
               uses: actions/checkout@v4
-            - name: Setup bun
-              uses: oven-sh/setup-bun@v1
-              with:
-                  bun-version: 1.1.18
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
             - name: Install dependencies
               run: bun install --frozen-lockfile
               env:
@@ -187,10 +169,8 @@ jobs:
         steps:
             - name: Checkout
               uses: actions/checkout@v4
-            - name: Setup bun
-              uses: oven-sh/setup-bun@v1
-              with:
-                  bun-version: 1.1.18
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
             - name: Install dependencies
               run: bun install --frozen-lockfile
               env:
@@ -201,16 +181,14 @@ jobs:
         runs-on: ubuntu-latest
         name: Build (Open Source)
         env:
-            NPMRC_FONT_AWESOME_TOKEN: ''
+            NPM_TOKEN_READONLY: ''
         steps:
             - name: Checkout
               uses: actions/checkout@v4
-            - name: Setup bun
-              uses: oven-sh/setup-bun@v1
-              with:
-                  bun-version: 1.1.18
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
             - name: Install dependencies
-              run: bun install --frozen-lockfile
+              run: bun install
               env:
                   PUPPETEER_SKIP_DOWNLOAD: 1
             - run: bun run build
@@ -220,10 +198,8 @@ jobs:
         steps:
             - name: Checkout
               uses: actions/checkout@v4
-            - name: Setup bun
-              uses: oven-sh/setup-bun@v1
-              with:
-                  bun-version: 1.1.18
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
             - name: Install dependencies
               run: bun install --frozen-lockfile
               env:

.github/workflows/publish.yaml

@@ -17,10 +17,8 @@ jobs:
               with:
                   # This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits
                   fetch-depth: 0
-            - name: Setup bun
-              uses: oven-sh/setup-bun@v1
-              with:
-                  bun-version: 1.1.18
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
             - name: Install dependencies
               run: bun install --frozen-lockfile
               env:
@@ -34,7 +32,7 @@ jobs:
                   # Using a PAT instead of GITHUB_TOKEN because we need to run workflows when releases are created
                   # https://github.com/orgs/community/discussions/26875#discussioncomment-3253761
                   GITHUB_TOKEN: ${{ secrets.GH_PERSONAL_TOKEN }}
-                  NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+                  NPM_TOKEN_READONLY: ${{ secrets.NPM_TOKEN_READONLY }}
                   CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
                   CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}
     release-preview:
@@ -45,10 +43,8 @@ jobs:
         steps:
             - name: Checkout Repo
               uses: actions/checkout@v3
-            - name: Setup bun
-              uses: oven-sh/setup-bun@v1
-              with:
-                  bun-version: 1.1.18
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
             - name: Install dependencies
               run: bun install --frozen-lockfile
               env:

.prettierignore

@@ -8,3 +8,6 @@ packages/icons/src/data/*.json
 
 # Build files
 dist/
+
+README.md
+CHANGELOG.md

README.md

@@ -78,6 +78,26 @@ Any published GitBook site can be accessed through your local development instan
 
 All pull-requests will be tested against both visual and performances testing to prevent regressions.
 
+## Fonts and Icons
+
+GitBook Open uses fontawesome. During development, your local environment will use the free version. However, only the pro version will be accepted by CI. If you see the following error:
+
+```
+The GitBook icon is missing. It indicates that the dependencies were installed without the correct font-awesome package. These changes have probably been persisted in the Bun lockfile. Read the README for more information.
+```
+
+It means that you've changed the GBO dependencies and bundled in the free version. Only GitBook staff can help with this - if you're not on the GitBook team, please ping us in the PR and we'll help get things moving.
+
+If you are GitBook staff, you'll need our NPM token in your local environment.
+
+```
+.env.local
+
+NPM_TOKEN_READONLY=xxx
+```
+
+and then reinstall dependencies.
+
 ## Contributing
 
 GitBook's rendering engine is fully open source and built on top of [Next.js](https://nextjs.org/). Head to our [contributing guide](https://github.com/GitbookIO/gitbook/blob/main/.github/CONTRIBUTING.md) to learn more about the workflow on adding your first Pull Request.

bunfig.toml

@@ -1,2 +1,2 @@
 [install.scopes]
-"awesome.me" = { token = "$NPMRC_FONT_AWESOME_TOKEN", url = "https://npm.fontawesome.com/" }
+"gitbook" = { token = "$NPM_TOKEN_READONLY", url = "https://registry.npmjs.org" }

package.json

@@ -7,12 +7,14 @@
         "turbo": "^2.1.2"
     },
     "packageManager": "bun@1.1.18",
-    "patchedDependencies": {
-        "@vercel/next@4.3.15": "patches/@vercel%2Fnext@4.3.15.patch"
+    "overrides": {
+        "@codemirror/state": "6.4.1",
+        "react": "18.3.1",
+        "react-dom": "18.3.1"
     },
     "private": true,
     "scripts": {
-        "dev": "turbo run dev",
+        "dev": "turbo run dev --ui=stream",
         "build": "turbo run build",
         "build:cloudflare": "turbo run build:cloudflare",
         "lint": "turbo run lint",
@@ -30,5 +32,9 @@
     },
     "workspaces": [
         "packages/*"
-    ]
+    ],
+    "patchedDependencies": {
+        "decode-named-character-reference@1.0.2": "patches/decode-named-character-reference@1.0.2.patch",
+        "@vercel/next@4.3.15": "patches/@vercel%2Fnext@4.3.15.patch"
+    }
 }

packages/cache-do/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @gitbook/cache-do
 
+## 0.1.1
+
+### Patch Changes
+
+-   b7a5106: Disable cloudflare observability in production
+
 ## 0.1.0
 
 ### Minor Changes

packages/cache-do/package.json

@@ -14,7 +14,7 @@
             "default": "./dist/api.js"
         }
     },
-    "version": "0.1.0",
+    "version": "0.1.1",
     "dependencies": {
         "@msgpack/msgpack": "^3.0.0-beta2",
         "lru_map": "^0.4.1"

packages/cache-do/wrangler.toml

@@ -11,8 +11,7 @@ migrations = [
 ]
 
 [observability]
-enabled = true
-head_sampling_rate = 0.01
+enabled = false
 
 [env.preview]
 name = "gitbook-open-cache-preview"
@@ -25,4 +24,4 @@ migrations = [
 
 [env.preview.observability]
 enabled = true
-head_sampling_rate = 1
+head_sampling_rate = 0.1

packages/gitbook/CHANGELOG.md

@@ -1,5 +1,45 @@
 # gitbook
 
+## 0.5.0
+
+### Minor Changes
+
+-   57cdd25: GitBook Open now supports Ask AI in sites. When asking a question to Ask AI, GitBook will use context from across your site sections and variants to provide the best answer.
+-   ca134c8: Fix an issue where the active site section indicator appeared above any dropdowns.
+-   d48926e: Fix an issue where the space dropdown was shown under the site sections in Safari.
+-   9fe8142: Fix an issue where Ask AI was erroring due to an object being passed as a param.
+-   d843e5e: Fix an issue where the space dropdown could appear behind the header.
+-   a2e5647: Fix the styling of site section tabs on smaller screens.
+
+### Patch Changes
+
+-   076dc48: Fix expandable block anchore resolution
+-   d9bb9f9: Fix an issue with the cookie banner buttons being non responsive
+-   23584c9: Update the site header with new styling, a new search button, and refactored layout
+-   664debc: Add support for tint color
+-   4d56f11: Update styling of search+ask modal
+-   061c0c1: Fix a regression in variant drop-down caused by missing z-index.
+-   2f76712: Add breadcrumbs above page title
+-   07cf835: Add scroll margin to the top when there are sections
+-   5d72b35: Smoother tab transition for sections
+-   7c71363: Don't adjust fallback font for mono font.
+-   7675c2c: Optimize performances by using new API endpoint for fetching site data.
+-   87eea73: Fix margin and image resolution of header logo
+-   aa2ed0f: Restyle hint blocks
+-   ffd3937: Fix security issue with image resizing that could be used for phishing
+-   2ce59d7: Fix - whitespace added to site section tabs with icons.
+-   c73e07d: Increase token max length to fix code not highlighted
+-   3b3d6e2: Add icons to sections
+-   1ed18c0: style: adds missing scalar css variables
+-   Updated dependencies [b7a5106]
+-   Updated dependencies [4771c78]
+-   Updated dependencies [ff50ac2]
+-   Updated dependencies [867481c]
+-   Updated dependencies [7ba67fd]
+-   Updated dependencies [a78c1ec]
+    -   @gitbook/cache-do@0.1.1
+    -   @gitbook/react-openapi@0.7.1
+
 ## 0.4.0
 
 ### Minor Changes

packages/gitbook/next.config.js

@@ -4,11 +4,13 @@ module.exports = withSentryConfig(
     {
         env: {
             BUILD_VERSION: (process.env.GITHUB_SHA ?? '').slice(0, 7),
+            SENTRY_RELEASE: process.env.SENTRY_RELEASE ?? '',
             SENTRY_DSN: process.env.SENTRY_DSN ?? '',
             SENTRY_ENVIRONMENT: process.env.SENTRY_ENVIRONMENT ?? 'development',
             GITBOOK_ASSETS_PREFIX: process.env.GITBOOK_ASSETS_PREFIX,
             GITBOOK_ICONS_URL: process.env.GITBOOK_ICONS_URL,
             GITBOOK_ICONS_TOKEN: process.env.GITBOOK_ICONS_TOKEN,
+            NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: process.env.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY,
         },
 
         webpack(config, { dev, webpack }) {
@@ -67,19 +69,15 @@ module.exports = withSentryConfig(
         },
     },
     {
-        silent: true,
+        release: process.env.SENTRY_RELEASE,
         org: process.env.SENTRY_ORG,
         project: process.env.SENTRY_PROJECT,
-    },
-    {
+        authToken: process.env.SENTRY_AUTH_TOKEN,
+
         // Upload a larger set of source maps for prettier stack traces (increases build time)
         widenClientFileUpload: true,
-        transpileClientSDK: false,
         // Routes browser requests to Sentry through a Next.js rewrite to circumvent ad-blockers (increases server load)
         tunnelRoute: '/~gitbook/monitoring',
-        // Don't hide source maps from generated client bundles
-        hideSourceMaps: false,
         disableLogger: true,
-        automaticVercelMonitors: false,
     },
 );

packages/gitbook/package.json

@@ -1,11 +1,11 @@
 {
     "name": "gitbook",
-    "version": "0.4.0",
+    "version": "0.5.0",
     "private": true,
     "scripts": {
         "dev": "env-cmd --silent -f ../../.env.local next dev",
         "build": "next build",
-        "build:cloudflare": "next-on-pages",
+        "build:cloudflare": "next-on-pages --custom-entrypoint=./src/cloudflare-entrypoint.ts",
         "start": "next start",
         "lint": "next lint",
         "typecheck": "tsc --noEmit",
@@ -16,7 +16,7 @@
         "clean": "rm -rf ./.next && rm -rf ./public/~gitbook/static"
     },
     "dependencies": {
-        "@gitbook/api": "^0.73.0",
+        "@gitbook/api": "^0.87.0",
         "@gitbook/cache-do": "workspace:*",
         "@gitbook/emoji-codepoints": "workspace:*",
         "@gitbook/icons": "workspace:*",
@@ -25,7 +25,7 @@
         "@gitbook/react-openapi": "workspace:*",
         "@radix-ui/react-checkbox": "^1.0.4",
         "@radix-ui/react-popover": "^1.0.7",
-        "@sentry/nextjs": "^7.94.1",
+        "@sentry/nextjs": "8.35.0",
         "@sindresorhus/fnv1a": "^3.1.0",
         "@tailwindcss/container-queries": "^0.1.1",
         "@tailwindcss/typography": "^0.5.10",
@@ -43,16 +43,15 @@
         "memoizee": "^0.4.15",
         "next": "14.2.15",
         "next-themes": "^0.2.1",
-        "nuqs": "^1.17.4",
+        "nuqs": "^2.2.3",
         "object-hash": "^3.0.0",
         "openapi-types": "^12.1.3",
         "p-map": "^7.0.0",
         "parse-cache-control": "^1.0.1",
         "postcss-color-contrast": "^1.1.0",
-        "react": "^18",
-        "react-dom": "^18",
+        "react": "18.3.1",
+        "react-dom": "18.3.1",
         "react-hotkeys-hook": "^4.4.1",
-        "recoil": "^0.7.7",
         "rehype-sanitize": "^6.0.0",
         "rehype-stringify": "^10.0.0",
         "remark-gfm": "^4.0.0",
@@ -60,17 +59,18 @@
         "remark-rehype": "^11.1.0",
         "rison": "^0.1.1",
         "server-only": "^0.0.1",
-        "shiki": "^1.22.0",
+        "shiki": "^1.26.1",
         "tailwind-merge": "^2.2.0",
         "tailwind-shades": "^1.1.2",
         "unified": "^11.0.4",
-        "url-join": "^5.0.0"
+        "url-join": "^5.0.0",
+        "usehooks-ts": "^3.1.0"
     },
     "devDependencies": {
-        "@argos-ci/playwright": "^2.0.0",
-        "@playwright/test": "^1.42.1",
-        "@cloudflare/next-on-pages": "^1.13.5",
-        "@cloudflare/workers-types": "^4.20240725.0",
+        "@argos-ci/playwright": "^3.10.0",
+        "@cloudflare/next-on-pages": "1.13.7",
+        "@cloudflare/workers-types": "^4.20241230.0",
+        "@playwright/test": "^1.49.1",
         "@types/js-cookie": "^3.0.6",
         "@types/jsontoxml": "^1.0.5",
         "@types/jsonwebtoken": "^9.0.6",
@@ -78,10 +78,12 @@
         "@types/object-hash": "^3.0.6",
         "@types/parse-cache-control": "^1.0.4",
         "@types/psi": "^4.1.6",
-        "@types/react": "^18.3.3",
-        "@types/react-dom": "^18.3.0",
+        "@types/react": "18.3.13",
+        "@types/react-dom": "18.3.1",
         "@types/rison": "^0.0.9",
         "autoprefixer": "^10",
+        "deepmerge": "^4.3.1",
+        "env-cmd": "^10.1.0",
         "eslint": "^8",
         "eslint-config-next": "^14.2.5",
         "eslint-plugin-import": "^2.29.1",
@@ -89,8 +91,7 @@
         "postcss": "^8",
         "psi": "^4.1.0",
         "tailwindcss": "^3.4.0",
-        "typescript": "^5.5.3",
-        "env-cmd": "^10.1.0",
-        "ts-essentials": "^10.0.1"
+        "ts-essentials": "^10.0.1",
+        "typescript": "^5.5.3"
     }
 }

packages/gitbook/sentry.client.config.ts

@@ -1,27 +1,18 @@
-import {
-    BrowserClient,
-    makeFetchTransport,
-    defaultStackParser,
-    getCurrentScope,
-} from '@sentry/nextjs';
+import * as Sentry from '@sentry/browser';
 
 const dsn = process.env.SENTRY_DSN;
 if (dsn) {
-    // To tree shake default integrations that we don't use
-    // https://docs.sentry.io/platforms/javascript/guides/nextjs/configuration/tree-shaking/#tree-shaking-default-integrations
-    const client = new BrowserClient({
-        debug: false,
+    Sentry.init({
         dsn,
-        integrations: [],
-        sampleRate: 0.1,
-        enableTracing: false,
+        release: process.env.SENTRY_RELEASE,
+
+        // Disable tracing as it creates additional requests in an env where subrequests are limited.
+        tracesSampleRate: 0,
+
+        // Disable transactions  as it creates additional requests in an env where subrequests are limited.
+        // https://docs.sentry.io/platforms/node/configuration/filtering/#using--3
         beforeSendTransaction: () => {
             return null;
         },
-        transport: makeFetchTransport,
-        stackParser: defaultStackParser,
     });
-
-    getCurrentScope().setClient(client);
-    client.init();
 }

packages/gitbook/sentry.server.config.ts

@@ -1,20 +0,0 @@
-import { init } from '@sentry/nextjs';
-
-const dsn = process.env.SENTRY_DSN;
-if (dsn) {
-    init({
-        debug: false,
-        dsn,
-
-        sampleRate: 0.1,
-
-        // Disable tracing as it creates additional requests in an env where subrequests are limited.
-        enableTracing: false,
-
-        // Disable transactions  as it creates additional requests in an env where subrequests are limited.
-        // https://docs.sentry.io/platforms/node/configuration/filtering/#using--3
-        beforeSendTransaction: () => {
-            return null;
-        },
-    });
-}

packages/gitbook/src/app/(global)/~gitbook/image/route.ts

@@ -1,11 +1,12 @@
-import { NextRequest } from 'next/server';
+import { NextRequest, NextResponse } from 'next/server';
 
 import {
+    CURRENT_SIGNATURE_VERSION,
+    isSignatureVersion,
+    SignatureVersion,
     verifyImageSignature,
-    resizeImage,
-    CloudflareImageOptions,
-    checkIsSizableImageURL,
-} from '@/lib/images';
+} from '@/lib/image-signatures';
+import { resizeImage, CloudflareImageOptions, checkIsSizableImageURL } from '@/lib/images';
 import { parseImageAPIURL } from '@/lib/urls';
 
 export const runtime = 'edge';
@@ -18,22 +19,21 @@ export const runtime = 'edge';
 export async function GET(request: NextRequest) {
     let urlParam = request.nextUrl.searchParams.get('url');
     const signature = request.nextUrl.searchParams.get('sign');
-    // The current signature algorithm sets version as 1, but we need to support the older version as well
-    // for previously generated content. In this case, we default to version 0.
-    const signatureVersion = (request.nextUrl.searchParams.get('sv') as '1') || '0';
+
     if (!urlParam || !signature) {
         return new Response('Missing url/sign parameters', { status: 400 });
     }
 
-    const url = parseImageAPIURL(urlParam);
-
-    // Prevent infinite loops
-    if (url.includes('/~gitbook/image')) {
-        return new Response('Invalid url parameter', { status: 400 });
+    const signatureVersion = parseSignatureVersion(request.nextUrl.searchParams.get('sv'));
+    if (!signatureVersion) {
+        return new Response(`Invalid sv parameter`, { status: 400 });
     }
 
+    const url = parseImageAPIURL(urlParam);
+
     // Check again if the image can be sized, even though we checked when rendering the Image component
     // Otherwise, it's possible to pass just any link to this endpoint and trigger HTML injection on the domain
+    // Also prevent infinite redirects.
     if (!checkIsSizableImageURL(url)) {
         return new Response('Invalid url parameter', { status: 400 });
     }
@@ -44,6 +44,10 @@ export async function GET(request: NextRequest) {
         return new Response(`Invalid signature "${signature ?? ''}" for "${url}"`, { status: 400 });
     }
 
+    if (signatureVersion !== CURRENT_SIGNATURE_VERSION) {
+        return NextResponse.redirect(url, 302);
+    }
+
     // Cloudflare-specific options are in the cf object.
     const options: CloudflareImageOptions = {
         fit: 'scale-down',
@@ -88,6 +92,24 @@ export async function GET(request: NextRequest) {
         return response;
     } catch (error) {
         // Redirect to the original image if resizing fails
-        return Response.redirect(url, 302);
+        return NextResponse.redirect(url, 302);
     }
 }
+
+/**
+ * Parse the image signature version from a query param. Returns null if the version is invalid.
+ */
+function parseSignatureVersion(input: string | null): SignatureVersion | null {
+    // Before introducing the sv parameter, all signatures were generated with version 0.
+    if (!input) {
+        return '0';
+    }
+
+    // If the query param explicitly asks for a signature version.
+    if (isSignatureVersion(input)) {
+        return input;
+    }
+
+    // Otherwise the version is invalid.
+    return null;
+}