Bump api package

.bun-version

@@ -1 +0,0 @@
-1.2.1

.changeset/beige-crabs-attack.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Avoid multiple <h1> in the page by using a <div> for the title in the header

.changeset/beige-snails-count.md

@@ -0,0 +1,6 @@
+---
+'@gitbook/react-openapi': patch
+'gitbook': patch
+---
+
+Adds content-visibility css property to OpenAPI Operation for better render performance

.changeset/big-chicken-poke.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/cache-do': minor
+---
+
+Experiment with optimizing billable duration in Cloudflare by using multiple RPC sessions instead of one

.changeset/blue-wasps-sparkle.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix scroll position when navigating pages on mobile

.changeset/brave-camels-trade.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': minor
+---
+
+Add Python support in Code Samples

.changeset/clean-balloons-travel.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+RND-3532: drop down menu for hidden links at small screen size

.changeset/cold-knives-judge.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Change dark mode shadow for multi-space search toolbar

.changeset/dull-gifts-flow.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Use ellipsis and fix icon color for more links in the header on small screen

.changeset/eighty-owls-type.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Improve consistency of change request preview by removing cache-control on response

.changeset/fast-timers-sniff.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/icons': patch
+---
+
+Update version for static assets to fix invalid caching

.changeset/fluffy-peas-tie.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Revalidate change request cached content when pressing refresh button

.changeset/forty-trains-pull.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/icons': patch
+---
+
+Fix first run of the package in development mode

.changeset/gentle-oranges-nail.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Improve performances of loading pages with embeds by caching them

.changeset/green-swans-boil.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': patch
+---
+
+bump: scalar from 1.0.5 to 1.0.7

.changeset/healthy-spoons-itch.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Replace all icons, previously imported from Geist, by new package `@gitbook/icons`

.changeset/heavy-jeans-unite.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/cache-do': minor
+---
+
+First version of a new cache backend powered by Cloudflare Durable Objects

.changeset/honest-jars-refuse.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Add support for Norwegian language

.changeset/hungry-actors-march.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Optimize layout shift while transitioning between pages with full width blocks (ex: OpenAPI blocks)

.changeset/hungry-students-sing.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Add support for page icons

.changeset/khaki-phones-jog.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix GitBook specific static assets not being served correctly when deployed on Cloudflare

.changeset/kind-flies-impress.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Only display spaces dropdown in compact header when site is multi-variants

.changeset/light-pots-dress.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/cache-do': patch
+---
+
+Enable Workers observability with a sampling of 0.1

.changeset/lovely-donkeys-deny.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/icons': minor
+---
+
+Initial release for `@gitbook/icons`, a package of content icons to be used for pages, documents, etc.

.changeset/lovely-hats-peel.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Automatically scroll to active item in TOC

.changeset/mighty-apples-design.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Persist state of tabs and dynamically sync them based on title

.changeset/nervous-turtles-lick.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Ensure "Sponsored via GitBook" can be translated in all languages

.changeset/nine-maps-judge.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Show the caption for file blocks

.changeset/ninety-starfishes-refuse.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Use url hash to open Expandable and scroll to anchor

.changeset/odd-beds-walk.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix margin for paragraphs in quote blocks

.changeset/odd-candles-cover.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Use new cache backend, powered by Durable Objects, alongside the existing ones (KV, etc).

.changeset/pink-feet-bake.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Include offset in calculations of whether scrollable element is in view

.changeset/plenty-pets-hope.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': minor
+---
+
+Add required query parameters to the code sample

.changeset/poor-bats-cheer.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': minor
+---
+
+Display pattern if available in parmas in OpenAPI block

.changeset/poor-emus-remember.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix inconsistent click area in table because of scroll indicator

.changeset/popular-toys-argue.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Stop using KV cache backend for now, but also improves it for higher performances

.changeset/purple-forks-refuse.md

@@ -0,0 +1,6 @@
+---
+'@gitbook/react-openapi': minor
+'gitbook': patch
+---
+
+Synchronize response and response example tabs

.changeset/purple-lies-teach.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Show definition title when visible in cards

.changeset/quiet-doors-double.md

@@ -0,0 +1,6 @@
+---
+'@gitbook/react-openapi': minor
+'gitbook': patch
+---
+
+Rollback of scalar modal while fixing perf issue

.changeset/rare-maps-call.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Optimize images rendered in community ads

.changeset/rare-plants-listen.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Update design of Checkbox to be more consistent and readable

.changeset/red-bats-chew.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-contentkit': patch
+---
+
+Fix rendering of webframe with SSR causing wrong communication between frame and renderer

.changeset/shiny-boats-push.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Disable KV cache for docs.gitbook.com as a test, also disable it for change-request to improve consistency

.changeset/shy-buttons-relate.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Add optional env `GITBOOK_INTEGRATIONS_HOST` to configure the host serving the integrations

.changeset/silent-donuts-love.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': patch
+---
+
+Fix crash when `example` is undefined for a response

.changeset/sixty-paws-share.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Improve the toolbar for change-requests and revisions to show more actions

.changeset/smooth-moose-marry.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Add support for icons style customization for sites

.changeset/strange-eyes-notice.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': patch
+---
+
+Adds tabs to Response Example section e.g. for status code examples

.changeset/ten-carpets-cover.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': patch
+---
+
+Render mandatory headers in code sample

.changeset/tender-onions-jog.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': patch
+---
+
+Update Scalar client to latest version

.changeset/thick-dogs-bake.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Prevent search indexation for pages where it's configured as disabled

.changeset/three-shoes-talk.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix table of contents being visible on mobile when disabled at the page level

.changeset/tricky-hounds-smoke.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix accessibility of the table of contents by using `aria-current` instead of `aria-selected`

.changeset/unlucky-balloons-explain.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Update rendering of community ads to match new API response, and make it possible to preview ads.

.changeset/violet-beers-matter.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-math': minor
+---
+
+Export binary `gitbook-math` to copy assets to a directory

.changeset/weak-hairs-compete.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix "ip" being passed to BSA for community ads

.changeset/wicked-bees-change.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Changed the alternative URL resolution criteria in order to support site URLs without /v/ prefix

.changeset/wild-worms-roll.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/icons': minor
+---
+
+Fix bin gitbook-icons when installed without the Pro token

.changeset/wise-papayas-retire.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Don't show hidden pages in the empty state of a page

.changeset/witty-kiwis-knock.md

@@ -0,0 +1,5 @@
+---
+'gitbook': minor
+---
+
+Fix linking to a tab itself

.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@v4
+          uses: actions/cache@v3
           id: playwright-cache
           with:
               path: '~/.cache/ms-playwright'

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

@@ -1,18 +0,0 @@
-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:
-    NPM_TOKEN_READONLY: ${{ secrets.NPM_TOKEN_READONLY }}
+    NPMRC_FONT_AWESOME_TOKEN: ${{ secrets.NPMRC_FONT_AWESOME_TOKEN }}
 jobs:
     deploy:
         name: Deploy to Cloudflare Pages
@@ -13,22 +13,29 @@ jobs:
         permissions:
             contents: read
             deployments: write
-            issues: write
-            pull-requests: write
-            checks: write
-            statuses: write
         outputs:
-            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
-            deployment-alias-url: ${{ steps.deploy.outputs.deployment-alias-url }}
+            deployment_url: ${{ steps.cloudflare.outputs.url }}
         steps:
             - name: Checkout
               uses: actions/checkout@v4
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
+            - name: Setup bun
+              uses: oven-sh/setup-bun@v1
+              with:
+                  bun-version: 1.1.18
             - 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
@@ -39,196 +46,33 @@ jobs:
                   echo "SENTRY_ENVIRONMENT=preview" >> $GITHUB_ENV
               if: 1 && !startsWith(github.ref, 'refs/heads/main')
             - name: Build Next.js with next-on-pages
-              run: bun run turbo build:cloudflare
+              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.11.0
+            - id: cloudflare
+              name: Publish to Cloudflare Pages
+              uses: cloudflare/pages-action@v1
               with:
                   apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
                   accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+                  projectName: ${{ vars.CLOUDFLARE_PROJECT_NAME }}
+                  directory: ./packages/gitbook/.vercel/output/static
+                  gitHubToken: ${{ secrets.GITHUB_TOKEN }}
                   workingDirectory: ./
-                  wranglerVersion: '3.82.0'
-                  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.deployment-url }}"
-                  echo "Alias URL: ${{ steps.deploy.outputs.deployment-alias-url }}"
+                  echo "ID: ${{ steps.cloudflare.outputs.id }}"
+                  echo "URL: ${{ steps.cloudflare.outputs.url }}"
+                  echo "Environment: ${{ steps.cloudflare.outputs.environment }}"
+                  echo "Alias: ${{ steps.cloudflare.outputs.alias }}"
             - name: Archive build output
               uses: actions/upload-artifact@v4
               with:
                   name: build-output
                   path: .vercel/
-            # Until https://github.com/cloudflare/wrangler-action/issues/301 is done
-            - name: Update Deployment Status to Success
-              env:
-                  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.deployment-url }}", "description": "Deployed Preview URL for commit", "context": "cloudflare/preview"}' \
-                    https://api.github.com/repos/${{ github.repository }}/statuses/${{ github.sha }}
-    deploy-v2-vercel:
-        name: Deploy v2 to Vercel
-        runs-on: ubuntu-latest
-        permissions:
-            contents: read
-            deployments: write
-            issues: write
-            pull-requests: write
-            checks: write
-            statuses: write
-        outputs:
-            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
-        env:
-            VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
-            VERCEL_PROJECT_ID: ${{ secrets.VERCEL_PROJECT_ID }}
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v4
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
-            - name: Install dependencies
-              run: bun install --frozen-lockfile
-              env:
-                  PUPPETEER_SKIP_DOWNLOAD: 1
-            - name: Sets env vars for production
-              run: |
-                  echo "VERCEL_ENVIRONMENT=production" >> $GITHUB_ENV
-                  echo "SENTRY_ENVIRONMENT=production" >> $GITHUB_ENV
-                  echo "GITBOOK_ASSETS_PREFIX=https://static.gitbook.com" >> $GITHUB_ENV
-              if: startsWith(github.ref, 'refs/heads/main')
-            - name: Sets env vars for preview
-              run: |
-                  echo "VERCEL_ENVIRONMENT=preview" >> $GITHUB_ENV
-                  echo "SENTRY_ENVIRONMENT=preview" >> $GITHUB_ENV
-              if: 1 && !startsWith(github.ref, 'refs/heads/main')
-            - name: Pull Vercel Environment Information
-              run: bun run vercel pull --yes --environment=$VERCEL_ENVIRONMENT --token=${{ secrets.VERCEL_TOKEN }}
-            - name: Build Project Artifacts
-              run: bun run vercel build --token=${{ secrets.VERCEL_TOKEN }}
-              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 }}
-            - name: Deploy Project Artifacts to Vercel
-              id: deploy
-              run: |
-                  DEPLOYMENT_URL=$(bun run vercel deploy --prebuilt --token=${{ secrets.VERCEL_TOKEN }})
-                  echo "deployment-url=$DEPLOYMENT_URL" >> "$GITHUB_OUTPUT"
-            - name: Outputs
-              run: |
-                  echo "URL: ${{ steps.deploy.outputs.deployment-url }}"
-    deploy-v2-cloudflare:
-        name: Deploy v2 to Cloudflare Worker
-        runs-on: ubuntu-latest
-        permissions:
-            contents: read
-            deployments: write
-            issues: write
-            pull-requests: write
-            checks: write
-            statuses: write
-        outputs:
-            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
-        env:
-            VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
-            VERCEL_PROJECT_ID: ${{ secrets.VERCEL_PROJECT_ID }}
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v4
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
-            - name: Install dependencies
-              run: bun install --frozen-lockfile
-              env:
-                  PUPPETEER_SKIP_DOWNLOAD: 1
-            - name: Sets env vars for production
-              run: |
-                  echo "SENTRY_ENVIRONMENT=production" >> $GITHUB_ENV
-                  echo "GITBOOK_ASSETS_PREFIX=https://static.gitbook.com" >> $GITHUB_ENV
-              if: startsWith(github.ref, 'refs/heads/main')
-            - name: Sets env vars for preview
-              run: |
-                  echo "SENTRY_ENVIRONMENT=preview" >> $GITHUB_ENV
-              if: 1 && !startsWith(github.ref, 'refs/heads/main')
-            - name: Build worker
-              run: bun run turbo build:v2: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.11.0
-              with:
-                  apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
-                  accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
-                  workingDirectory: ./
-                  wranglerVersion: '3.82.0'
-                  command: versions upload --config ./packages/gitbook-v2/wrangler.toml
-            - name: Outputs
-              run: |
-                  echo "URL: ${{ steps.deploy.outputs.deployment-url }}"
-    comment-deployments:
-        runs-on: ubuntu-latest
-        name: Comment Deployments
-        if: always() && !startsWith(github.ref, 'refs/heads/main')
-        needs:
-            - deploy
-            - deploy-v2-vercel
-            - deploy-v2-cloudflare
-        steps:
-            - name: Find GitHub Comment
-              uses: peter-evans/find-comment@v3
-              id: fc
-              with:
-                  issue-number: ${{ github.event.pull_request.number }}
-                  comment-author: 'github-actions[bot]'
-                  body-includes: 'Summary of the deployments'
-
-            - name: Create or update GitHub comment
-              uses: peter-evans/create-or-update-comment@v4
-              with:
-                  comment-id: ${{ steps.fc.outputs.comment-id }}
-                  issue-number: ${{ github.event.pull_request.number }}
-                  body: |
-                      Summary of the deployments:
-
-                      ### Version 1 (production)
-
-                      | Version | URL | Status |
-                      | --- | --- | --- |
-                      | Latest commit | [${{ needs.deploy.outputs.deployment-url }}](${{ needs.deploy.outputs.deployment-url }}) | ${{ needs.deploy.result == 'success' && '✅' || '❌' }} |
-                      | PR | [${{ needs.deploy.outputs.deployment-alias-url }}](${{ needs.deploy.outputs.deployment-alias-url }}) | ${{ needs.deploy.result == 'success' && '✅' || '❌' }} |
-
-                      ### Version 2 (experimental)
-
-                      | Version | URL | Status |
-                      | --- | --- | --- |
-                      | Vercel | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}](${{ needs.deploy-v2-vercel.outputs.deployment-url }}) | ${{ needs.deploy-v2-vercel.result == 'success' && '✅' || '❌' }} |
-                      | Cloudflare | [${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}](${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}) | ${{ needs.deploy-v2-cloudflare.result == 'success' && '✅' || '❌' }} |
-
-                      ### Test content
-
-                      | Site | v1 | v2 |
-                      | --- | --- | --- |
-                      | GitBook | [${{ needs.deploy.outputs.deployment-url }}/docs.gitbook.com](${{ needs.deploy.outputs.deployment-url }}/docs.gitbook.com) | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}/static/url/docs.gitbook.com](${{ needs.deploy-v2-vercel.outputs.deployment-url }}/static/url/docs.gitbook.com) |
-                      | E2E | [${{ needs.deploy.outputs.deployment-url }}/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy.outputs.deployment-url }}/gitbook.gitbook.io/test-gitbook-open) | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}/static/url/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy-v2-vercel.outputs.deployment-url }}/static/url/gitbook.gitbook.io/test-gitbook-open) |
-                  edit-mode: replace
     visual-testing:
         runs-on: ubuntu-latest
         name: Visual Testing
@@ -236,8 +80,10 @@ jobs:
         steps:
             - name: Checkout
               uses: actions/checkout@v4
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
+            - name: Setup bun
+              uses: oven-sh/setup-bun@v1
+              with:
+                  bun-version: 1.1.18
             - name: Install dependencies
               run: bun install --frozen-lockfile
             - name: Setup Playwright
@@ -245,7 +91,7 @@ jobs:
             - name: Run Playwright tests
               run: bun e2e
               env:
-                  BASE_URL: ${{needs.deploy.outputs.deployment-url}}
+                  BASE_URL: ${{needs.deploy.outputs.deployment_url}}
                   ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
             - uses: actions/upload-artifact@v4
               if: ${{ !cancelled() }}
@@ -253,31 +99,6 @@ jobs:
                   name: playwright-test-results
                   path: packages/gitbook/test-results/
                   retention-days: 3
-    visual-testing-customers:
-        runs-on: ubuntu-latest
-        name: Visual Testing Customers
-        needs: deploy
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v4
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
-            - name: Install dependencies
-              run: bun install --frozen-lockfile
-            - name: Setup Playwright
-              uses: ./.github/actions/setup-playwright
-            - name: Run Playwright tests
-              run: bun e2e-customers
-              env:
-                  BASE_URL: ${{needs.deploy.outputs.deployment-url}}
-                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
-                  ARGOS_BUILD_NAME: 'customers'
-            - uses: actions/upload-artifact@v4
-              if: ${{ !cancelled() }}
-              with:
-                  name: playwright-test-results-customers
-                  path: packages/gitbook/test-results/
-                  retention-days: 3
     pagespeed-testing:
         runs-on: ubuntu-latest
         name: PageSpeed Testing
@@ -285,8 +106,10 @@ jobs:
         steps:
             - name: Checkout
               uses: actions/checkout@v4
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
+            - name: Setup bun
+              uses: oven-sh/setup-bun@v1
+              with:
+                  bun-version: 1.1.18
             - name: Install dependencies
               run: bun install --frozen-lockfile
               env:
@@ -294,7 +117,7 @@ jobs:
             - name: Run pagespeed tests
               run: bun ./packages/gitbook/tests/pagespeed-testing.ts $DEPLOYMENT_URL
               env:
-                  DEPLOYMENT_URL: ${{needs.deploy.outputs.deployment-url}}
+                  DEPLOYMENT_URL: ${{needs.deploy.outputs.deployment_url}}
                   PAGESPEED_API_KEY: ${{ secrets.PAGESPEED_API_KEY }}
     format:
         runs-on: ubuntu-latest
@@ -302,8 +125,10 @@ jobs:
         steps:
             - name: Checkout
               uses: actions/checkout@v4
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
+            - name: Setup bun
+              uses: oven-sh/setup-bun@v1
+              with:
+                  bun-version: 1.1.18
             - name: Install dependencies
               run: bun install --frozen-lockfile
               env:
@@ -315,8 +140,10 @@ jobs:
         steps:
             - name: Checkout
               uses: actions/checkout@v4
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
+            - name: Setup bun
+              uses: oven-sh/setup-bun@v1
+              with:
+                  bun-version: 1.1.18
             - name: Install dependencies
               run: bun install --frozen-lockfile
               env:
@@ -328,8 +155,10 @@ jobs:
         steps:
             - name: Checkout
               uses: actions/checkout@v4
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
+            - name: Setup bun
+              uses: oven-sh/setup-bun@v1
+              with:
+                  bun-version: 1.1.18
             - name: Install dependencies
               run: bun install --frozen-lockfile
               env:
@@ -340,14 +169,16 @@ jobs:
         runs-on: ubuntu-latest
         name: Build (Open Source)
         env:
-            NPM_TOKEN_READONLY: ''
+            NPMRC_FONT_AWESOME_TOKEN: ''
         steps:
             - name: Checkout
               uses: actions/checkout@v4
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
+            - name: Setup bun
+              uses: oven-sh/setup-bun@v1
+              with:
+                  bun-version: 1.1.18
             - name: Install dependencies
-              run: bun install
+              run: bun install --frozen-lockfile
               env:
                   PUPPETEER_SKIP_DOWNLOAD: 1
             - run: bun run build
@@ -357,8 +188,10 @@ jobs:
         steps:
             - name: Checkout
               uses: actions/checkout@v4
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
+            - name: Setup bun
+              uses: oven-sh/setup-bun@v1
+              with:
+                  bun-version: 1.1.18
             - name: Install dependencies
               run: bun install --frozen-lockfile
               env:

.github/workflows/publish.yaml

@@ -17,8 +17,10 @@ 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: ./.github/composite/setup-bun
+            - name: Setup bun
+              uses: oven-sh/setup-bun@v1
+              with:
+                  bun-version: 1.1.18
             - name: Install dependencies
               run: bun install --frozen-lockfile
               env:
@@ -43,8 +45,10 @@ jobs:
         steps:
             - name: Checkout Repo
               uses: actions/checkout@v3
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
+            - name: Setup bun
+              uses: oven-sh/setup-bun@v1
+              with:
+                  bun-version: 1.1.18
             - name: Install dependencies
               run: bun install --frozen-lockfile
               env:

.prettierignore

@@ -1,6 +1,5 @@
 .next
 .vercel
-.open-next
 
 # Generated
 packages/emoji-codepoints/index.ts
@@ -9,6 +8,3 @@ packages/icons/src/data/*.json
 
 # Build files
 dist/
-
-README.md
-CHANGELOG.md

README.md

@@ -35,10 +35,8 @@ To run a local version of this project, please follow these simple steps.
 
 ### Prerequisites
 
--   Node.js (Version: >=20.6)
-  - Use nvm for easy Node management
--   Bun (Version: >=1.2.1)
-  - We use a text-based lockfile which isn't supported below 1.2.1
+-   Node.js (Version: >=18.x)
+-   Bun
 
 ### Set up
 
@@ -80,26 +78,6 @@ 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]
-"gitbook" = { token = "$NPM_TOKEN_READONLY", url = "https://registry.npmjs.org" }
+"awesome.me" = { token = "$NPMRC_FONT_AWESOME_TOKEN", url = "https://npm.fontawesome.com/" }

package.json

@@ -2,24 +2,19 @@
     "name": "gitbook",
     "version": "0.1.0",
     "devDependencies": {
-        "@changesets/cli": "^2.27.12",
+        "@changesets/cli": "^2.27.7",
         "prettier": "^3.0.3",
-        "turbo": "^2.4.1-canary.2",
-        "vercel": "^39.3.0"
+        "turbo": "^2.1.2"
     },
     "packageManager": "bun@1.1.18",
-    "overrides": {
-        "@codemirror/state": "6.4.1",
-        "react": "18.3.1",
-        "react-dom": "18.3.1"
+    "patchedDependencies": {
+        "@vercel/next@4.3.6": "patches/@vercel%2Fnext@4.3.6.patch"
     },
     "private": true,
     "scripts": {
         "dev": "turbo run dev",
-        "dev:v2": "turbo run dev:v2",
         "build": "turbo run build",
-        "build:v2": "turbo run build:v2",
-        "clean-deps": "rm -rf node_modules && rm -rf packages/*/node_modules",
+        "build:cloudflare": "turbo run build:cloudflare",
         "lint": "turbo run lint",
         "lint:fix": "turbo run lint -- --fix",
         "typecheck": "turbo run typecheck",
@@ -27,7 +22,6 @@
         "format:check": "prettier ./ --ignore-unknown --list-different",
         "unit": "turbo run unit",
         "e2e": "turbo run e2e",
-        "e2e-customers": "turbo run e2e-customers",
         "changeset": "changeset",
         "release": "turbo run release && changeset publish",
         "release:preview": "turbo run release:preview",
@@ -36,9 +30,5 @@
     },
     "workspaces": [
         "packages/*"
-    ],
-    "patchedDependencies": {
-        "decode-named-character-reference@1.0.2": "patches/decode-named-character-reference@1.0.2.patch",
-        "@vercel/next@4.4.2": "patches/@vercel%2Fnext@4.4.2.patch"
-    }
+    ]
 }

packages/cache-do/CHANGELOG.md

@@ -1,18 +0,0 @@
-# @gitbook/cache-do
-
-## 0.1.1
-
-### Patch Changes
-
--   b7a5106: Disable cloudflare observability in production
-
-## 0.1.0
-
-### Minor Changes
-
--   9b8d519: Experiment with optimizing billable duration in Cloudflare by using multiple RPC sessions instead of one
--   636b868: First version of a new cache backend powered by Cloudflare Durable Objects
-
-### Patch Changes
-
--   56f5fa1: Enable Workers observability with a sampling of 0.1

packages/cache-do/package.json

@@ -14,14 +14,14 @@
             "default": "./dist/api.js"
         }
     },
-    "version": "0.1.1",
+    "version": "0.0.0",
     "dependencies": {
         "@msgpack/msgpack": "^3.0.0-beta2",
         "lru_map": "^0.4.1"
     },
     "devDependencies": {
         "typescript": "^5.5.3",
-        "wrangler": "3.82.0"
+        "wrangler": "^3.78.7"
     },
     "scripts": {
         "generate": "wrangler types --experimental-include-runtime",

packages/cache-do/wrangler.toml

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

packages/gitbook-v2/.gitignore

@@ -1,8 +0,0 @@
-# next.js
-/.next/
-
-# vercel
-.vercel
-
-# cloudflare
-.open-next

packages/gitbook-v2/CHANGELOG.md

@@ -1,7 +0,0 @@
-# gitbook-v2
-
-## 0.1.0
-
-### Minor Changes
-
--   cfccc44: Setup structure and deployment for new version

packages/gitbook-v2/README.md

@@ -1,104 +0,0 @@
-# GitBook V2
-
-This package contains the code for an experiment new version of the GitBook renderer.
-
-The goals of this new version are:
-
-- Optimize rendering to leverage Next.js ISR and static rendering
-- Leverage Node.js runtime and bigger instances to render bigger content
-- Evaluate Vercel and Cloudflare deployment options
-
-## Deployment
-
-#### Vercel
-
-The new version is deployed automatically to Vercel using a Github Action on every push.
-
-#### Cloudflare with Opennext-js
-
-The new version is deployed automatically to Cloudflare using a Github Action on every push.
-
-## Potential issues
-
-- [ ] We can't use `dynamicIO` because our root layout needs to fetch the params (https://github.com/vercel/next.js/discussions/71927)
-- [ ] How to do `nonce` for static resources when we can't use `headers()` (dynamic API) (https://nextjs.org/docs/app/building-your-application/configuring/content-security-policy)
-
-## Structure
-
-#### Middleware:
-
-Goals:
-- Route between dynamic and static routes
-  - If a token is in the cookies => dynamic route
-  - If a token is in the url => dynamic route
-  - Else => static route
-- High performances:
-  - It should not rely on data fetching
-
-#### URLs to support:
-
-Content URLs:
-
-- `docs.company.com/page`
-  - Middleware: rewrite to `/static/url/docs.company.com/page`
-  - Page component renders the page
-- `docs.company2.com/section/page`
-  - Middleware: rewrite to `/static/url/docs.company2.com/section/page`
-  - Page component renders the page
-- `docs.company3.com/section/sitespace/page`
-  - Middleware: rewrite to `/static/url/docs.company3.com/section/sitespace/page`
-  - Page component renders the page
-
-Content URLs (adaptive content or visitor authentication):
-
-- `docs.company.com/page`
-  - Middleware:
-    - If a token is in the cookies or url => dynamic route
-    - Else => rewrite to `/dynamic/url/docs.company.com/page`
-  - Page component renders the page
-    - Read the token from the url query params or cookies
-
-
-PDF export URLs:
-
-- `docs.company.com/page/~gitbook/pdf`
-  - Middleware: rewrite to `/dynamic/pdf/docs.company.com/page`
-  - Page component renders the page
-
-Images resizing:
-
-- `docs.company.com/~gitbook/image`
-  - Middleware: rewrite to `/dynamic/image/docs.company.com`
-  - Route handlers process the request
-
-Preview URLs:
-
-- `open.gitbook.com/sites/site_abc/page` (or `open.gitbook.com/~site/site_abc/page` to stay compatible?)
-  - Middleware: no rewrite
-  - Page component renders the page (dynamic?)
-     - Read the token from the url query params
-     - Read customizations override from the url query params
-
-
-Space PDF URLs:
-
-- `open.gitbook.com/spaces/space_abc/pdf`
-  - Middleware: no rewrite
-  - Page component renders the page (dynamic?)
-     - Read the token from the url query params
-     - Read customizations override from the url query params
-
-Development:
-
-- `localhost:3000/sites/site_abc/page`
-
-#### Routes:
-
-- Content
-    - [ ] `/static/url/[[...url]]/page.tsx`
-    - [ ] `/dynamic/url/[[...url]]/page.tsx`
-- Images resizing
-    - [ ] `/dynamic/image/[hostname]/route.ts`
-- PDF export
-    - [ ] `/dynamic/pdf/[[...url]]/page.tsx`
-    - [ ] `/spaces/[space]/pdf/page.tsx`

packages/gitbook-v2/next-env.d.ts

@@ -1,5 +0,0 @@
-/// <reference types="next" />
-/// <reference types="next/image-types/global" />
-
-// NOTE: This file should not be edited
-// see https://nextjs.org/docs/app/api-reference/config/typescript for more information.

packages/gitbook-v2/next.config.mjs

@@ -1,15 +0,0 @@
-// @ts-check
-
-/**
- * @type {import('next').NextConfig}
- */
-const nextConfig = {
-    experimental: {
-        useCache: true,
-
-        // We can't use dynamicIO because it doesn't accept reading params in the root layout
-        // dynamicIO: true,
-    },
-};
-
-export default nextConfig;

packages/gitbook-v2/open-next.config.ts

@@ -1,30 +0,0 @@
-// default open-next.config.ts file created by @opennextjs/cloudflare
-
-import cache from '@opennextjs/cloudflare/kvCache';
-
-const config = {
-    default: {
-        override: {
-            wrapper: 'cloudflare-node',
-            converter: 'edge',
-            incrementalCache: async () => cache,
-            tagCache: 'dummy',
-            queue: 'dummy',
-        },
-    },
-
-    middleware: {
-        external: true,
-        override: {
-            wrapper: 'cloudflare-edge',
-            converter: 'edge',
-            proxyExternalRequest: 'fetch',
-        },
-    },
-
-    dangerous: {
-        enableCacheInterception: false,
-    },
-};
-
-export default config;

packages/gitbook-v2/package.json

@@ -1,22 +0,0 @@
-{
-    "name": "gitbook-v2",
-    "version": "0.1.0",
-    "private": true,
-    "dependencies": {
-        "next": "canary",
-        "react": "^19.0.0",
-        "react-dom": "^19.0.0",
-        "@gitbook/api": "^0.93.0"
-    },
-    "devDependencies": {
-        "@opennextjs/cloudflare": "^0.4.3"
-    },
-    "scripts": {
-        "dev:v2": "next",
-        "build": "next build",
-        "build:v2": "next build",
-        "start": "next start",
-        "build:v2:cloudflare": "opennextjs-cloudflare",
-        "dev:v2:cloudflare": "wrangler dev --port 8771"
-    }
-}

packages/gitbook-v2/src/app/dynamic/url/[...url]/layout.tsx

@@ -1,15 +0,0 @@
-import { SiteContentLayout } from '@/components/routes/SiteContentLayout';
-import { createDynamicSiteContext } from '@/lib/context';
-
-export default async function RootLayout({
-    params,
-    children,
-}: {
-    params: Promise<{ url: string[] }>;
-    children: React.ReactNode;
-}) {
-    const { url } = await params;
-    const context = await createDynamicSiteContext(url);
-
-    return <SiteContentLayout context={context}>{children}</SiteContentLayout>;
-}

packages/gitbook-v2/src/app/dynamic/url/[...url]/page.tsx

@@ -1,9 +0,0 @@
-import { SiteContentPage } from '@/components/routes/SiteContentPage';
-import { createDynamicSiteContext } from '@/lib/context';
-
-export default async function Page({ params }: { params: Promise<{ url: string[] }> }) {
-    const { url } = await params;
-    const context = await createDynamicSiteContext(url);
-
-    return <SiteContentPage context={context} />;
-}

packages/gitbook-v2/src/app/static/url/[...url]/layout.tsx

@@ -1,21 +0,0 @@
-import { unstable_cacheTag as cacheTag } from 'next/cache';
-import { SiteContentLayout } from '@/components/routes/SiteContentLayout';
-import { getSiteCacheTag } from '@/lib/cache';
-import { createStaticSiteContext } from '@/lib/context';
-
-export default async function RootLayout({
-    params,
-    children,
-}: {
-    params: Promise<{ url: string[] }>;
-    children: React.ReactNode;
-}) {
-    'use cache';
-
-    const { url } = await params;
-    const context = await createStaticSiteContext(url);
-
-    cacheTag(getSiteCacheTag(context.siteId));
-
-    return <SiteContentLayout context={context}>{children}</SiteContentLayout>;
-}

packages/gitbook-v2/src/app/static/url/[...url]/page.tsx

@@ -1,15 +0,0 @@
-import { unstable_cacheTag as cacheTag } from 'next/cache';
-import { createStaticSiteContext } from '@/lib/context';
-import { getSiteCacheTag } from '@/lib/cache';
-import { SiteContentPage } from '@/components/routes/SiteContentPage';
-
-export default async function Page({ params }: { params: Promise<{ url: string[] }> }) {
-    'use cache';
-
-    const { url } = await params;
-    const context = await createStaticSiteContext(url);
-
-    cacheTag(getSiteCacheTag(context.siteId));
-
-    return <SiteContentPage context={context} />;
-}

packages/gitbook-v2/src/components/routes/SiteContentLayout.tsx

@@ -1,27 +0,0 @@
-import { GitBookSiteContext } from '@/lib/context';
-
-/**
- * Layout component to render the site content.
- */
-export async function SiteContentLayout({
-    context,
-    children,
-}: {
-    context: GitBookSiteContext;
-    children: React.ReactNode;
-}) {
-    const { api } = context;
-    const { data: publishedSite } = await api.orgs.getPublishedContentSite(
-        context.organizationId,
-        context.siteId,
-    );
-
-    return (
-        <html lang="en">
-            <body>
-                <h1>{publishedSite.site.title}</h1>
-                {children}
-            </body>
-        </html>
-    );
-}

packages/gitbook-v2/src/components/routes/SiteContentPage.tsx

@@ -1,12 +0,0 @@
-import { GitBookSiteContext } from '@/lib/context';
-
-export async function SiteContentPage({ context }: { context: GitBookSiteContext }) {
-    const { api } = context;
-    const { data } = await api.orgs.getPublishedContentSite(context.organizationId, context.siteId);
-
-    return (
-        <div>
-            <p>Found site {data.site.id}</p>
-        </div>
-    );
-}

packages/gitbook-v2/src/lib/cache.ts

@@ -1,3 +0,0 @@
-export function getSiteCacheTag(siteId: string) {
-    return `sites/${siteId}`;
-}

packages/gitbook-v2/src/lib/context.ts

@@ -1,112 +0,0 @@
-import { headers } from 'next/headers';
-import { redirect } from 'next/navigation';
-import { GitBookAPI } from '@gitbook/api';
-import { GITBOOK_API_TOKEN, GITBOOK_API_URL, GITBOOK_USER_AGENT } from '@/lib/env';
-
-/**
- * Generic context about rendering content.
- */
-export interface GitBookContext {
-    /**
-     * API client to fetch data from GitBook.
-     */
-    api: GitBookAPI;
-}
-
-/**
- * Context when rendering a site.
- */
-export interface GitBookSiteContext extends GitBookContext {
-    /**
-     * ID of the organization.
-     */
-    organizationId: string;
-
-    /**
-     * Site ID.
-     */
-    siteId: string;
-}
-
-/**
- * Create a site context, when rendering a static page.
- */
-export async function createStaticSiteContext(url: string[]): Promise<GitBookSiteContext> {
-    const context = createStaticContext();
-    return fetchSiteContext(url, context);
-}
-
-/**
- * Create a site context, when rendering a dynamic page.
- */
-export async function createDynamicSiteContext(url: string[]): Promise<GitBookSiteContext> {
-    const context = await createDynamicContext();
-    return fetchSiteContext(url, context);
-}
-
-/**
- * Fetch the context of a site for a given URL and a base context.
- */
-async function fetchSiteContext(
-    urlParts: string[],
-    baseContext: GitBookContext,
-): Promise<GitBookSiteContext> {
-    const { api } = baseContext;
-    const url = getURLFromParams(urlParts);
-    const { data } = await api.urls.getPublishedContentByUrl({
-        url,
-    });
-
-    if ('redirect' in data) {
-        redirect(data.redirect);
-    }
-
-    return {
-        ...baseContext,
-        api: new GitBookAPI({
-            endpoint: api.endpoint,
-            authToken: data.apiToken,
-            userAgent: api.userAgent,
-        }),
-        siteId: data.site,
-        organizationId: data.organization,
-    };
-}
-
-/**
- * Create the base context when rendering statically.
- */
-function createStaticContext(): GitBookContext {
-    const api = new GitBookAPI({
-        authToken: GITBOOK_API_TOKEN,
-        endpoint: GITBOOK_API_URL,
-        userAgent: GITBOOK_USER_AGENT,
-    });
-
-    return {
-        api,
-    };
-}
-
-/**
- * Create the base context when rendering dynamically.
- * The context will depend on the request.
- */
-async function createDynamicContext(): Promise<GitBookContext> {
-    const headersSet = await headers();
-
-    const api = new GitBookAPI({
-        authToken: headersSet.get('x-gitbook-token') ?? GITBOOK_API_TOKEN,
-        endpoint: headersSet.get('x-gitbook-api') ?? GITBOOK_API_URL,
-        userAgent: GITBOOK_USER_AGENT,
-    });
-
-    return {
-        api,
-    };
-}
-
-function getURLFromParams(input: string[]) {
-    const url = new URL('https://' + input.join('/'));
-    return url.toString();
-}

packages/gitbook-v2/src/lib/env.ts

@@ -1,15 +0,0 @@
-/**
- * Default GitBook API URL endpoint.
- */
-export const GITBOOK_API_URL = process.env.GITBOOK_API_URL ?? 'https://api.gitbook.com';
-
-/**
- * Default GitBook API token.
- * It can be use to avoid rate-limiting.
- */
-export const GITBOOK_API_TOKEN = process.env.GITBOOK_API_TOKEN ?? null;
-
-/**
- * User agent to use for API requests.
- */
-export const GITBOOK_USER_AGENT = process.env.GITBOOK_USER_AGENT ?? 'GitBook-Open/2.0.0';

packages/gitbook-v2/src/middleware.ts

@@ -1,11 +0,0 @@
-import { NextResponse } from 'next/server';
-import type { NextRequest } from 'next/server';
-
-export const config = {
-    matcher: ['/((?!_next/|_static/|_vercel|[\\w-]+\\.\\w+).*)'],
-};
-
-export function middleware(request: NextRequest) {
-    // No rewrite
-    return NextResponse.next();
-}

packages/gitbook-v2/tsconfig.json

@@ -1,28 +0,0 @@
-{
-    "compilerOptions": {
-        "target": "esnext",
-        "lib": ["dom", "dom.iterable", "esnext"],
-        "allowJs": true,
-        "skipLibCheck": true,
-        "strict": false,
-        "noEmit": true,
-        "incremental": true,
-        "module": "esnext",
-        "esModuleInterop": true,
-        "moduleResolution": "bundler",
-        "resolveJsonModule": true,
-        "isolatedModules": true,
-        "jsx": "preserve",
-        "plugins": [
-            {
-                "name": "next"
-            }
-        ],
-        "paths": {
-            "@/*": ["./src/*"],
-            "@v1/*": ["../gitbook/src/*"]
-        }
-    },
-    "include": ["next-env.d.ts", ".next/types/**/*.ts", "**/*.ts", "**/*.tsx"],
-    "exclude": ["node_modules"]
-}

packages/gitbook-v2/wrangler.toml

@@ -1,5 +0,0 @@
-main = ".open-next/worker.js"
-name = "gitbook-v2"
-compatibility_date = "2024-09-23"
-compatibility_flags = ["nodejs_compat"]
-assets = { directory = ".open-next/assets", binding = "ASSETS" }

packages/gitbook/.gitignore

@@ -32,5 +32,4 @@ screenshots/
 /playwright/.cache/
 
 # Generated public files
-/public/~gitbook/static/*
-!/public/~gitbook/static/images
+/public/~gitbook/static/

packages/gitbook/CHANGELOG.md

@@ -1,310 +1,5 @@
 # gitbook
 
-## 0.6.1
-
-### Patch Changes
-
--   dddb4ec: Fix long tab group description
--   Updated dependencies [f8d4c76]
--   Updated dependencies [dddb4ec]
--   Updated dependencies [f8d4c76]
-    -   @gitbook/react-openapi@1.0.1
-
-## 0.6.0
-
-### Minor Changes
-
--   98245e5: Adapt code to pull token from customer backend generated custom cookies
--   af3c6a9: Reintroduce a safety check around search whilst we continue investigating caching.
--   95f2aa4: Track new events for site insights when ads are being clicked
--   08acea6: Investigate an issue causing caches to return empty objects instead of null/undefined.
--   1138d59: Add support for sidebar background styles
--   9e18ae6: Overhaul colour scale & Tailwind colour classes
--   e86e51f: Fix an issue where the redirects of potentially malicious images were not going through.
--   7059c2b: Add support for computed content by fetching computed documents for pages.
--   c71d159: Track events for site insights using the new dedicated API.
--   eb7c22f: Revert scalar to 1.0.87 to mitigate an issue with ApiClientModalProvider
--   ea1468c: Send redirectOnError param to getPublishedContent when token is pulled from cookie
--   7ee9158: Restyle PageAside to use sidebar list styles
--   dbba50c: Fix an issue where search and Ask AI triggers unnecessary renders when in a Visitor Authenticated site.
--   1417279: Track clicks on links (header, footer, content) for site insights.
--   9eca010: Improve the display of recommended questions by streaming them.
--   160fca1: new OpenAPI blocks design
--   71688a8: Introduction of new themes: Clean, Muted, Bold, and Gradient
--   1823101: Fix internal properties appearing in OpenAPI docs.
--   6a073e1: Add antialiasing for text rendering
--   8126a83: Improve readability of tables with hover style and vertical dividers
--   db74ea3: Image optimization endpoint redirects to underlying image URL if the signature is not the latest.
--   99579ac: Fix a vulnerability issue for images using an older version of the image signing parameter.
--   e4e2f52: Track an event into site insights when visitor is opening the Scalar API client.
-
-### Patch Changes
-
--   d876399: Fix UI search without ask AI enabled and fix error with questions not returned from API
--   c30bc24: Fix empty sitemap
--   e90c96f: page outline on the right remains visible when scrolling, move mode toggler to PageAside
--   5b4e710: Support llms.txt
--   b6c3870: Add support for keyboard marks
--   6059efe: Fix search no results error showing while there are results
--   c77142a: Log component stack in Sentry
--   1de9d1a: Apply antialiasing on any text that are not code inline/blocks to avoid contrast issues
--   32aa1f9: Handle security issue with cookies on Safari
--   d935fb1: Don't add extra page scroll when footer is not present
--   53de5b1: Fix site section URL resolution in Ask AI sources
--   24f5249: Fix vertical section overflow color
--   1762f85: Reduce gap between subsequent header buttons
--   c1e27cc: Fix pass Sentry release properly
--   5ae1b88: Fix shrinking page icons
--   8f046a9: Start using tint in more places, TOC and PageAside
--   665b6be: Ignore invalid API calls to `getSiteRedirectFromSource` API
-
-    To reduce the load on the API and also avoid errors.
-
--   26e6401: Remove KV cache backend and only rely on DO as an external cache backend
--   8cfa67c: Fix default outline list styling
--   d66c184: Ignore errors from event flushing
--   6088fa5: Simplify search results logic to investigate a bug
--   68287d3: Cache API spec for 24 hours, revalidated every 2 hours
--   09c7c30: Try to fix error on og image generation
--   ae99f87: Improve emoji setup, align with GitBook app
--   2906e60: Downgrade to Next.js v14 to fix incompatibilities with next-on-pages causing multiple bugs.
--   3a7210d: Fix zoom image view transition on Safari
--   718a8a5: Position the variant picker in the ToC
--   e5dc05e: Update footer styling and allow for more than 4 footer groups
--   8276ba0: Make cookies access safer
--   1b8a456: Fix Image blocks zoomable behaviour
--   56c52e0: Handle Firefox security error on localStorage
--   0510b6f: Add section description to SectionGroupTile
--   1fcc807: Fix errors from customization not found
--   46edde9: Improve the OpenAPI package API
--   8af1abc: Improve contrast of search box placeholder
--   92b7668: Improve header offset
--   d9c8d57: Do not dereference before caching OpenAPI spec.
--   94876e3: Fix regression issue with page icons for multi-line titles
--   47971dc: Fix OG image generation for non-latin characters
--   82dc9c4: Simplify the `useHash` algo used.
--   128ad20: Ignore cache invalidation error from local backend
--   ff05e20: Improvements to inline images in headings
--   cb100d5: Allow only good values for theme query parameter. Avoid having a 500 error when we pass an invalid value.
--   d5aaccd: Remove use of deprecatd API createSitesPageFeedback
--   48ab59f: Improve colour contrast of list item decoration
--   d2bc567: Set Sentry release
--   37d13d8: Avoid error on fetch by passing a string URL
--   d3e573c: Generate sitemap for all sections and spaces
--   f7b801b: Add feedback form to page rating control
--   d370a3f: Update the routes for changes/revisions in multi-id mode to match the normal mode
--   46f63cb: Fix code format overriding inline link styles
--   5950657: Fix emojis display
--   528a053: Fix server actions stability leading to no results found sometimes on search
--   eac1314: Lazy load iframely script to make page more responsive
--   ad19060: Cards stand out slighly more on tinted and dark mode sites, and have better support for headings inside them
--   6f54826: New highlight colors
--   5c87ec7: Implement a safer way to interact with localStorage.
-
-    If it's disabled on the browser it should not throw error.
-
--   02d876e: Fix search UI behaviour
--   f4a90de: Fix two issues where pages would crash due Recoil not behaving correctly in RSC.
--   5576906: Fix table of content displaying arrow next to page with only hidden pages
--   aaab157: Visual fix for section group in Safari
--   cbe6139: Fix dynamic tabs infinite loop
--   65cc4af: Fix error when accessing a change request not found
--   727bde2: Improve and split OpenAPI parser into its own package
--   0b6ddca: Fix variant selector contrast for non-default themes
--   87b8ea8: Fix issue leading to increase the storage write and the stability of the platform
--   fde32e2: Force route handler to be dynamic to avoid errors
--   a025118: Change card layout depending on cover aspect ratio
--   300f7bf: Fix search loading state
--   29d5979: Disable C/C++ highlight temporarily
--   18953b2: Subtler tint color when based on the primary color, by mixing in some gray
--   1c97536: Fix Sentry instrumentation
--   b0bd871: Even safer localStorage
--   b950a64: Avoid errors on legacy browsers
--   38061bd: Add section groups to section tabs
--   160fca1: Support deprecated and x-deprecated-sunset in OpenAPI spec
--   0e601e2: Improve styling of header buttons with shadows and high-contrast styles
--   6691492: Fix viewing PDF from space
--   e8e64bf: Fix bullet list display on full size blocks
--   16194c5: Vertical orientation for sections list on sites without header
--   b41d425: Improve OpenAPI rendering performances by caching markdown parsing
--   1f8e416: Improve performances by highlighting code client-side if the code block is offscreen
--   1429384: Fix error when accessing some not found pages.
--   21cbd9e: Change link color to primary-subtle
--   5dab70f: Fix "Parser" language syntax highlighting
--   deb8c54: Upgrade Next.js to v15, upgrade Shiki and use JS RegExp engine
--   56331d2: Fix breadcrumbs emoji display + add contrast styles
--   a6f6591: Fix server actions cache compromised. Leading to some bugs on frontend.
--   44a20fe: Improve smoothness of scroll listener
--   5664e5a: Fix variant dropdown styling in header
--   6b50360: Fix view transition error on Safari
--   741dd49: Bump `heading-3` font size to offset it from paragraphs
--   5112e3e: Fix Sentry instrumentation server-side
--   1de338c: Remove animation on section tabs. Page is reloaded (for technical reasons), so the animation is not accurate here.
--   Updated dependencies [d9029c7]
--   Updated dependencies [6e54a06]
--   Updated dependencies [162b4b7]
--   Updated dependencies [e4e2f52]
--   Updated dependencies [0c03676]
--   Updated dependencies [3e5e458]
--   Updated dependencies [46edde9]
--   Updated dependencies [d9c8d57]
--   Updated dependencies [ccf2cff]
--   Updated dependencies [dda0cc6]
--   Updated dependencies [eb7c22f]
--   Updated dependencies [ea1468c]
--   Updated dependencies [648f0e9]
--   Updated dependencies [160fca1]
--   Updated dependencies [f92e906]
--   Updated dependencies [e721f17]
--   Updated dependencies [727bde2]
--   Updated dependencies [dff08ae]
--   Updated dependencies [fc7b16f]
--   Updated dependencies [fe8acc9]
--   Updated dependencies [1823101]
--   Updated dependencies [a652958]
--   Updated dependencies [2f73db7]
--   Updated dependencies [160fca1]
--   Updated dependencies [12c7862]
--   Updated dependencies [b41d425]
-    -   @gitbook/react-openapi@1.0.0
-    -   @gitbook/openapi-parser@1.0.0
-    -   @gitbook/react-contentkit@0.6.0
-
-## 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
-
--   e09f747: Revalidate change request cached content when pressing refresh button
--   2fa0851: Add navigation tabs for sections
--   a4b63b8: Support resolution of new site URLs with sections
--   5c35f36: Replace all icons, previously imported from Geist, by new package `@gitbook/icons`
--   e9b31a5: Unify section tab styles with page item styles
--   f12a215: Add support for Norwegian language
--   f4c9536: Optimize layout shift while transitioning between pages with full width blocks (ex: OpenAPI blocks)
--   1f24fe4: Add support for page icons
--   cda08a9: Add support for searching results in a sections site
--   b32e40c: Persist state of tabs and dynamically sync them based on title
--   15d2ee3: Show the caption for file blocks
--   f885e88: Improve the toolbar for change-requests and revisions to show more actions
--   07ea45b: Remove deprecated synced block from GitBook Open
--   c3675fd: Added support for new Reusable Content block.
--   1f24fe4: Add support for icons style customization for sites
--   4c19014: Prevent search indexation for pages where it's configured as disabled
--   3422ad4: Update rendering of community ads to match new API response, and make it possible to preview ads.
--   1152445: Changed the alternative URL resolution criteria in order to support site URLs without /v/ prefix
--   2c437f7: Fix linking to a tab itself
-
-### Patch Changes
-
--   aa32198: Avoid multiple <h1> in the page by using a <div> for the title in the header
--   51fa3ab: Adds content-visibility css property to OpenAPI Operation for better render performance
--   a7066cc: Fix scroll position when navigating pages on mobile
--   c754fc9: Add automatic color contrast in site header, restyle search button
--   5fe7adb: RND-3532: drop down menu for hidden links at small screen size
--   6295881: Change dark mode shadow for multi-space search toolbar
--   f89b31c: Upgrade the scalar api client package
--   13c7534: Use ellipsis and fix icon color for more links in the header on small screen
--   f885e88: Improve consistency of change request preview by removing cache-control on response
--   16e6171: Improve performances of loading pages with embeds by caching them
--   34d36c6: Fix GitBook specific static assets not being served correctly when deployed on Cloudflare
--   af9e66e: Only display spaces dropdown in compact header when site is multi-variants
--   e3a3d6a: Improve perception of fast loading by not rendering skeletons for individual blocks in the top part of the viewport
--   042b850: Automatically scroll to active item in TOC
--   d43202f: Optimize bundle size of the server output by reducing bundle size of shiki (skipping themes)
--   bfbed1a: Ensure "Sponsored via GitBook" can be translated in all languages
--   fe9e6c1: Update ogimage with new design
--   17f71ba: Use url hash to open Expandable and scroll to anchor
--   3c07e65: Fix margin for paragraphs in quote blocks
--   636b868: Use new cache backend, powered by Durable Objects, alongside the existing ones (KV, etc).
--   f16560c: Include offset in calculations of whether scrollable element is in view
--   689f553: Fix inconsistent click area in table because of scroll indicator
--   6ce3cea: Stop using KV cache backend for now, but also improves it for higher performances
--   e914903: Synchronize response and response example tabs
--   0f990c7: Show definition title when visible in cards
--   e3a3d6a: Fix flickering when displaying an "Ask" answer with code blocks
--   4cbcc5b: Rollback of scalar modal while fixing perf issue
--   3996110: Optimize images rendered in community ads
--   133c3e7: Update design of Checkbox to be more consistent and readable
--   5096f7f: Disable KV cache for docs.gitbook.com as a test, also disable it for change-request to improve consistency
--   0f1565c: Add optional env `GITBOOK_INTEGRATIONS_HOST` to configure the host serving the integrations
--   2ff7ed1: Fix table of contents being visible on mobile when disabled at the page level
--   b075f0f: Fix accessibility of the table of contents by using `aria-current` instead of `aria-selected`
--   cb782a7: Fix "ip" being passed to BSA for community ads
--   a7af3ca: Improving the look and feel of new section tabs
--   0bf985a: Don't show hidden pages in the empty state of a page
--   d6c28a0: Update header styling of sections, variant selector, and button links
-
-    -   Change position of variant selector depending on context (next to logo or in table of contents)
-    -   Update section tab styling and animation
-    -   Make header buttons smaller with a new `medium` button size
-
--   Updated dependencies [51fa3ab]
--   Updated dependencies [9b8d519]
--   Updated dependencies [cf3045a]
--   Updated dependencies [f89b31c]
--   Updated dependencies [d0f4860]
--   Updated dependencies [ef9d012]
--   Updated dependencies [094e9cd]
--   Updated dependencies [636b868]
--   Updated dependencies [56f5fa1]
--   Updated dependencies [5c35f36]
--   Updated dependencies [4247361]
--   Updated dependencies [aa8c49e]
--   Updated dependencies [e914903]
--   Updated dependencies [4cbcc5b]
--   Updated dependencies [0f1565c]
--   Updated dependencies [237b703]
--   Updated dependencies [51955da]
--   Updated dependencies [a679e72]
--   Updated dependencies [c079c3c]
--   Updated dependencies [5c35f36]
--   Updated dependencies [776bc31]
-    -   @gitbook/react-openapi@0.7.0
-    -   @gitbook/cache-do@0.1.0
-    -   @gitbook/icons@0.1.0
-    -   @gitbook/react-contentkit@0.5.1
-    -   @gitbook/react-math@0.6.0
-
 ## 0.3.0
 
 ### Minor Changes

packages/gitbook/e2e/customers.spec.ts

@@ -1,240 +0,0 @@
-import { runTestCases, TestsCase, waitForCookiesDialog } from './util';
-
-/** A list of test cases to run on the customers' docs sites. */
-const testCases: TestsCase[] = [
-    {
-        name: 'Snyk',
-        baseUrl: 'https://docs.snyk.io',
-        tests: [
-            { name: 'Home', url: '/' },
-            { name: 'OpenAPI', url: '/snyk-api/reference/apps' },
-        ],
-    },
-    {
-        name: 'Nexthink',
-        baseUrl: 'https://docs.nexthink.com',
-        tests: [{ name: 'Home', url: '/', screenshot: { waitForTOCScrolling: false } }],
-    },
-    {
-        name: 'asiksupport-stg.dto.kemkes.go.id',
-        baseUrl: 'https://asiksupport-stg.dto.kemkes.go.id',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'jasons-tutorials.gitbook.io',
-        baseUrl: 'https://jasons-tutorials.gitbook.io',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'faq.deltaemulator.com',
-        baseUrl: 'https://faq.deltaemulator.com',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'docs.dify.ai',
-        baseUrl: 'https://docs.dify.ai',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'seeddao.gitbook.io',
-        baseUrl: 'https://seeddao.gitbook.io',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'faq.altstore.io',
-        baseUrl: 'https://faq.altstore.io',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'support.audacityteam.org',
-        baseUrl: 'https://support.audacityteam.org',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'docs.gmgn.ai',
-        baseUrl: 'https://docs.gmgn.ai',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'docs.spicychat.ai',
-        baseUrl: 'https://docs.spicychat.ai',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'docs.portainer.io',
-        baseUrl: 'https://docs.portainer.io',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'docs.chirptoken.io',
-        baseUrl: 'https://docs.chirptoken.io',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'docs.dexscreener.com',
-        baseUrl: 'https://docs.dexscreener.com',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'docs.pancakeswap.finance',
-        baseUrl: 'https://docs.pancakeswap.finance',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'book.character.ai',
-        baseUrl: 'https://book.character.ai',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'docs.tradeonnova.io',
-        baseUrl: 'https://docs.tradeonnova.io',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'azcoiner.gitbook.io',
-        baseUrl: 'https://azcoiner.gitbook.io',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'docs.midas.app',
-        baseUrl: 'https://docs.midas.app',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'docs.keeper.io',
-        baseUrl: 'https://docs.keeper.io',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'adiblar.gitbook.io',
-        baseUrl: 'https://adiblar.gitbook.io',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'docs.gradient.network',
-        baseUrl: 'https://docs.gradient.network',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'mygate-network.gitbook.io',
-        baseUrl: 'https://mygate-network.gitbook.io',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'treasurenft.gitbook.io',
-        baseUrl: 'https://treasurenft.gitbook.io',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'browndust2.gitbook.io',
-        baseUrl: 'https://browndust2.gitbook.io',
-        tests: [{ name: 'Home', url: '/', screenshot: { waitForTOCScrolling: false } }],
-    },
-    {
-        name: 'junookyo.gitbook.io',
-        baseUrl: 'https://junookyo.gitbook.io',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'meshnet.nordvpn.com',
-        baseUrl: 'https://meshnet.nordvpn.com',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'manual.bubble.io',
-        baseUrl: 'https://manual.bubble.io',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'docs.tickettool.xyz',
-        baseUrl: 'https://docs.tickettool.xyz',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'wiki.redmodding.org',
-        baseUrl: 'https://wiki.redmodding.org',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'docs.cherry-ai.com',
-        baseUrl: 'https://docs.cherry-ai.com',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'docs.snyk.io',
-        baseUrl: 'https://docs.snyk.io',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'docs.realapp.link',
-        baseUrl: 'https://docs.realapp.link',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'docs.plaza.finance',
-        baseUrl: 'https://docs.plaza.finance',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'docs.publicai.io',
-        baseUrl: 'https://docs.publicai.io',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'hyperliquid.gitbook.io',
-        baseUrl: 'https://hyperliquid.gitbook.io',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'docs.umbraco.com',
-        baseUrl: 'https://docs.umbraco.com',
-        tests: [{ name: 'Home', url: '/welcome', screenshot: { waitForTOCScrolling: false } }],
-    },
-    {
-        name: 'sosovalue-white-paper.gitbook.io',
-        baseUrl: 'https://sosovalue-white-paper.gitbook.io',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'docs.revrobotics.com',
-        baseUrl: 'https://docs.revrobotics.com',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'chartschool.stockcharts.com',
-        baseUrl: 'https://chartschool.stockcharts.com',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'docs.soniclabs.com',
-        baseUrl: 'https://docs.soniclabs.com',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'docs.meshchain.ai',
-        baseUrl: 'https://docs.meshchain.ai',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'docs.thousandeyes.com',
-        baseUrl: 'https://docs.thousandeyes.com',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'docs.raydium.io',
-        baseUrl: 'https://docs.raydium.io',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'docs.solv.finance',
-        baseUrl: 'https://docs.solv.finance',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'docs.fluentbit.io',
-        baseUrl: 'https://docs.fluentbit.io',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-];
-
-runTestCases(testCases);

packages/gitbook/e2e/pages.spec.ts

@@ -0,0 +1,806 @@
+import { argosScreenshot } from '@argos-ci/playwright';
+import {
+    CustomizationHeaderPreset,
+    CustomizationIconsStyle,
+    CustomizationLocale,
+    SiteCustomizationSettings,
+} from '@gitbook/api';
+import { test, expect, Page } from '@playwright/test';
+import jwt from 'jsonwebtoken';
+import rison from 'rison';
+import { DeepPartial } from 'ts-essentials';
+
+import { getContentTestURL } from '../tests/utils';
+
+interface Test {
+    name: string;
+    url: string; // URL to visit for testing
+    run?: (page: Page) => Promise<unknown>; // The test to run
+    fullPage?: boolean; // Whether the test should be fullscreened during testing
+    screenshot?: false; // Should a screenshot be stored
+    only?: boolean; // Only run this test
+}
+
+interface TestsCase {
+    name: string;
+    baseUrl: string;
+    tests: Array<Test>;
+}
+
+const allLocales: CustomizationLocale[] = [
+    CustomizationLocale.Fr,
+    CustomizationLocale.Es,
+    CustomizationLocale.Ja,
+    CustomizationLocale.Zh,
+];
+
+async function waitForCookiesDialog(page: Page) {
+    const dialog = page.getByRole('dialog', { name: 'Cookies' });
+    const accept = dialog.getByRole('button', { name: 'Accept' });
+    const reject = dialog.getByRole('button', { name: 'Reject' });
+    await expect(accept).toBeVisible();
+    await expect(reject).toBeVisible();
+}
+
+const testCases: TestsCase[] = [
+    {
+        name: 'GitBook Site (Single Variant)',
+        baseUrl: 'https://gitbook-open-e2e-sites.gitbook.io/gitbook-doc/',
+        tests: [
+            {
+                name: 'Home',
+                url: '',
+                run: waitForCookiesDialog,
+            },
+            {
+                name: 'No variants dropdown',
+                url: '',
+                run: async (page) => {
+                    await expect(page.locator('[data-testid="space-dropdown-button"]')).toHaveCount(
+                        0,
+                    );
+                },
+            },
+            {
+                name: 'Search',
+                url: '?q=',
+            },
+            {
+                name: 'Search Results',
+                url: '?q=gitbook',
+                run: async (page) => {
+                    await page.waitForSelector('[data-test="search-results"]');
+                },
+            },
+            {
+                name: 'AI Search',
+                url: '?q=What+is+GitBook%3F&ask=true',
+                run: async (page) => {
+                    await page.waitForSelector('[data-test="search-ask-answer"]');
+                },
+                screenshot: false,
+            },
+            {
+                name: 'Not found',
+                url: 'content-not-found',
+                run: waitForCookiesDialog,
+            },
+        ],
+    },
+    {
+        name: 'GitBook Site (Multi Variants)',
+        baseUrl: 'https://gitbook-open-e2e-sites.gitbook.io/multi-variants/',
+        tests: [
+            {
+                name: 'Variants dropdown',
+                url: '',
+                run: async (page) => {
+                    const spaceDrowpdown = page.locator('[data-testid="space-dropdown-button"]');
+                    await spaceDrowpdown.waitFor();
+                },
+            },
+            {
+                name: 'Default variant',
+                url: '',
+            },
+            {
+                name: 'RFC variant',
+                url: 'rfcs',
+            },
+            {
+                name: 'Customized variant titles are displayed',
+                url: '',
+                run: async (page) => {
+                    const spaceDrowpdown = page.locator('[data-testid="space-dropdown-button"]');
+                    await spaceDrowpdown.click();
+
+                    const variantSelectionDropdown = page.locator(
+                        'css=[data-testid="space-dropdown-button"] + div',
+                    );
+                    // the customized space title
+                    await expect(
+                        variantSelectionDropdown.getByRole('link', {
+                            name: 'Multi-Variants',
+                        }),
+                    ).toBeVisible();
+
+                    // the NON-customized space title
+                    await expect(
+                        variantSelectionDropdown.getByRole('link', {
+                            name: 'RFCs',
+                        }),
+                    ).toBeVisible();
+                },
+            },
+        ],
+    },
+    {
+        name: 'GitBook Site (Navigation when switching variant)',
+        baseUrl: 'https://gitbook-open-e2e-sites.gitbook.io/',
+        tests: [
+            {
+                name: 'Keep navigation path/route when switching variant (Public)',
+                url: 'api-multi-versions/reference/api-reference/pets',
+                screenshot: false,
+                run: async (page) => {
+                    const spaceDrowpdown = await page.waitForSelector(
+                        '[data-testid="space-dropdown-button"]',
+                    );
+                    await spaceDrowpdown.click();
+
+                    // Click the second variant in the dropdown
+                    await page
+                        .getByRole('link', {
+                            name: '2.0',
+                        })
+                        .click();
+
+                    // It should keep the current page path, i.e "reference/api-reference/pets" when navigating to the new variant
+                    await page.waitForURL(
+                        'https://gitbook-open-e2e-sites.gitbook.io/api-multi-versions/2.0/reference/api-reference/pets?fallback=true',
+                    );
+                },
+            },
+            {
+                name: 'Keep navigation path/route when switching variant (Share link)',
+                url: 'api-multi-versions-share-links/8tNo6MeXg7CkFMzSSz81/reference/api-reference/pets',
+                screenshot: false,
+                run: async (page) => {
+                    const spaceDrowpdown = await page.waitForSelector(
+                        '[data-testid="space-dropdown-button"]',
+                    );
+                    await spaceDrowpdown.click();
+
+                    // Click the second variant in the dropdown
+                    await page
+                        .getByRole('link', {
+                            name: '2.0',
+                        })
+                        .click();
+
+                    // It should keep the current page path, i.e "reference/api-reference/pets" when navigating to the new variant
+                    await page.waitForURL(
+                        'https://gitbook-open-e2e-sites.gitbook.io/api-multi-versions-share-links/8tNo6MeXg7CkFMzSSz81/2.0/reference/api-reference/pets?fallback=true',
+                    );
+                },
+            },
+            {
+                name: 'Keep navigation path/route when switching variant (VA)',
+                screenshot: false,
+                url: (() => {
+                    const privateKey = 'c26190fc-74b2-4b54-9fc7-df9941104953';
+                    const token = jwt.sign(
+                        {
+                            name: 'gitbook-open-tests',
+                        },
+                        privateKey,
+                        {
+                            expiresIn: '24h',
+                        },
+                    );
+                    return `api-multi-versions-va/reference/api-reference/pets?jwt_token=${token}`;
+                })(),
+                run: async (page) => {
+                    const spaceDrowpdown = await page.waitForSelector(
+                        '[data-testid="space-dropdown-button"]',
+                    );
+                    await spaceDrowpdown.click();
+
+                    // Click the second variant in the dropdown
+                    await page
+                        .getByRole('link', {
+                            name: '2.0',
+                        })
+                        .click();
+
+                    // It should keep the current page path, i.e "reference/api-reference/pets" when navigating to the new variant
+                    await page.waitForURL(
+                        'https://gitbook-open-e2e-sites.gitbook.io/api-multi-versions-va/2.0/reference/api-reference/pets?fallback=true',
+                    );
+                },
+            },
+        ],
+    },
+    {
+        name: 'GitBook',
+        baseUrl: 'https://docs.gitbook.com',
+        tests: [
+            {
+                name: 'Home',
+                url: '',
+                run: waitForCookiesDialog,
+            },
+            {
+                name: 'Search',
+                url: '?q=',
+            },
+            {
+                name: 'Search Results',
+                url: '?q=gitbook',
+                run: async (page) => {
+                    await page.waitForSelector('[data-test="search-results"]');
+                },
+            },
+            {
+                name: 'AI Search',
+                url: '?q=What+is+GitBook%3F&ask=true',
+                run: async (page) => {
+                    await page.waitForSelector('[data-test="search-ask-answer"]');
+                },
+                screenshot: false,
+            },
+            {
+                name: 'Not found',
+                url: 'content-not-found',
+                run: waitForCookiesDialog,
+            },
+        ],
+    },
+    {
+        name: 'Versioning',
+        baseUrl: 'https://gitbook.gitbook.io/test-gitbook-open/',
+        tests: [
+            {
+                name: 'Revision',
+                url: '~/revisions/S55pwsEr5UVoroaOiWnP/blocks/headings',
+                run: waitForCookiesDialog,
+            },
+        ],
+    },
+    {
+        name: 'PDF',
+        baseUrl: 'https://gitbook.gitbook.io/test-gitbook-open/',
+        tests: [
+            {
+                name: 'PDF',
+                url: '~gitbook/pdf?limit=10',
+            },
+        ],
+    },
+    {
+        name: 'Content tests',
+        baseUrl: 'https://gitbook.gitbook.io/test-gitbook-open/',
+        tests: [
+            {
+                name: 'Text',
+                url: 'text-page',
+                run: waitForCookiesDialog,
+            },
+            {
+                name: 'Long text',
+                url: 'text-page/long-text',
+                run: waitForCookiesDialog,
+            },
+            {
+                name: 'Images',
+                url: 'blocks/block-images',
+                run: waitForCookiesDialog,
+                fullPage: true,
+            },
+            {
+                name: 'Inline Images',
+                url: 'blocks/inline-images',
+                run: waitForCookiesDialog,
+            },
+            {
+                name: 'Tabs',
+                url: 'blocks/tabs',
+                run: waitForCookiesDialog,
+            },
+            {
+                name: 'Hints',
+                url: 'blocks/hints',
+                run: waitForCookiesDialog,
+            },
+            {
+                name: 'Integration Blocks',
+                url: 'blocks/integrations',
+                run: waitForCookiesDialog,
+            },
+            {
+                name: 'Tables',
+                url: 'blocks/tables',
+                run: waitForCookiesDialog,
+                fullPage: true,
+            },
+            {
+                name: 'Expandables',
+                url: 'blocks/expandables',
+                run: waitForCookiesDialog,
+            },
+            {
+                name: 'API Blocks',
+                url: 'blocks/api-blocks',
+                run: waitForCookiesDialog,
+            },
+            {
+                name: 'Headings',
+                url: 'blocks/headings',
+                run: waitForCookiesDialog,
+            },
+            {
+                name: 'Marks',
+                url: 'blocks/marks',
+                run: waitForCookiesDialog,
+            },
+            {
+                name: 'Emojis',
+                url: 'blocks/emojis',
+                run: waitForCookiesDialog,
+            },
+            {
+                name: 'Links',
+                url: 'blocks/links',
+                run: waitForCookiesDialog,
+            },
+            {
+                name: 'Lists',
+                url: 'blocks/lists',
+                fullPage: true,
+            },
+            {
+                name: 'Code',
+                url: 'blocks/code',
+                fullPage: true,
+            },
+            {
+                name: 'Cards',
+                url: 'blocks/cards',
+                fullPage: true,
+            },
+            {
+                name: 'Math',
+                url: 'blocks/math',
+            },
+            {
+                name: 'Files',
+                url: 'blocks/files',
+                fullPage: true,
+            },
+            {
+                name: 'Embeds',
+                url: 'blocks/embeds',
+                fullPage: true,
+            },
+            {
+                name: 'Page links',
+                url: 'blocks/page-links',
+                fullPage: true,
+            },
+            {
+                name: 'Annotations',
+                url: 'blocks/annotations',
+                run: async (page) => {
+                    await page.waitForSelector('[data-testid="annotation-button"]');
+                    await page.click('[data-testid="annotation-button"]');
+                },
+            },
+        ],
+    },
+    {
+        name: 'Page options',
+        baseUrl: 'https://gitbook.gitbook.io/test-gitbook-open/',
+        tests: [
+            {
+                name: 'Hidden',
+                url: 'page-options/page-hidden',
+                run: waitForCookiesDialog,
+            },
+            {
+                name: 'With cover',
+                url: 'page-options/page-with-cover',
+                run: waitForCookiesDialog,
+            },
+            {
+                name: 'With hero cover',
+                url: 'page-options/page-with-hero-cover',
+                run: waitForCookiesDialog,
+            },
+            {
+                name: 'With cover and no TOC',
+                url: 'page-options/page-with-cover-and-no-toc',
+                run: waitForCookiesDialog,
+            },
+            {
+                name: 'With icon',
+                url: 'page-options/page-with-icon',
+                run: waitForCookiesDialog,
+            },
+        ],
+    },
+    {
+        name: 'Customization',
+        baseUrl: 'https://gitbook.gitbook.io/test-gitbook-open/',
+        tests: [
+            {
+                name: 'Without header',
+                url: getCustomizationURL({
+                    header: {
+                        preset: CustomizationHeaderPreset.None,
+                        links: [],
+                    },
+                }),
+                run: waitForCookiesDialog,
+            },
+            {
+                name: 'With duotone icons',
+                url:
+                    'page-options/page-with-icon' +
+                    getCustomizationURL({
+                        styling: {
+                            icons: CustomizationIconsStyle.Duotone,
+                        },
+                    }),
+                run: waitForCookiesDialog,
+            },
+            {
+                name: 'With header buttons',
+                url: getCustomizationURL({
+                    header: {
+                        preset: CustomizationHeaderPreset.Default,
+                        links: [
+                            {
+                                title: 'Secondary button',
+                                to: { kind: 'url', url: 'https://www.gitbook.com' },
+                                // @ts-ignore Remove once we upgrade to the latest version of the API
+                                style: 'button-secondary',
+                            },
+                            {
+                                title: 'Primary button',
+                                to: { kind: 'url', url: 'https://www.gitbook.com' },
+                                // @ts-ignore Remove once we upgrade to the latest version of the API
+                                style: 'button-primary',
+                            },
+                        ],
+                    },
+                }),
+                run: waitForCookiesDialog,
+            },
+        ],
+    },
+    {
+        name: 'Ads',
+        baseUrl: 'https://gitbook.gitbook.io/test-gitbook-open/',
+        tests: [
+            {
+                name: 'Without previewed ads',
+                url: 'text-page?ads_preview=1',
+                run: waitForCookiesDialog,
+            },
+        ],
+    },
+    {
+        name: 'Share links',
+        baseUrl: 'https://gitbook.gitbook.io/gbo-tests-share-links/',
+        tests: [
+            {
+                name: 'Valid link',
+                url: 'TGs8PkF4GWVtbmPnWhYL/',
+            },
+            {
+                name: 'Invalid link',
+                url: 'invalid/',
+                run: async (page) => {
+                    await expect(
+                        page.getByText('Authentication missing to access this content'),
+                    ).toBeVisible();
+                },
+            },
+        ],
+    },
+    {
+        name: 'Visitor Auth - Space',
+        baseUrl: `https://gitbook.gitbook.io/gbo-va-space/`,
+        tests: [
+            {
+                name: 'First',
+                url: (() => {
+                    const privateKey = '70b844d0-c519-4532-8586-5970ce48c537';
+                    const token = jwt.sign(
+                        {
+                            name: 'gitbook-open-tests',
+                        },
+                        privateKey,
+                        {
+                            expiresIn: '24h',
+                        },
+                    );
+                    return `first?jwt_token=${token}`;
+                })(),
+                run: waitForCookiesDialog,
+            },
+            {
+                name: 'Second',
+                url: (() => {
+                    const privateKey = '70b844d0-c519-4532-8586-5970ce48c537';
+                    const token = jwt.sign(
+                        {
+                            name: 'gitbook-open-tests',
+                        },
+                        privateKey,
+                        {
+                            expiresIn: '24h',
+                        },
+                    );
+                    return `second?jwt_token=${token}`;
+                })(),
+                run: waitForCookiesDialog,
+            },
+        ],
+    },
+    {
+        name: 'Visitor Auth - Collection',
+        baseUrl: `https://gitbook.gitbook.io/gbo-va-collection/`,
+        tests: [
+            {
+                name: 'Root',
+                url: (() => {
+                    const privateKey = 'af5688dc-f0b6-4146-9b1d-6d834c62c980';
+                    const token = jwt.sign(
+                        {
+                            name: 'gitbook-open-tests',
+                        },
+                        privateKey,
+                        {
+                            expiresIn: '24h',
+                        },
+                    );
+                    return `?jwt_token=${token}`;
+                })(),
+                run: waitForCookiesDialog,
+            },
+            {
+                name: 'Primary (Space A)',
+                url: (() => {
+                    const privateKey = 'af5688dc-f0b6-4146-9b1d-6d834c62c980';
+                    const token = jwt.sign(
+                        {
+                            name: 'gitbook-open-tests',
+                        },
+                        privateKey,
+                        {
+                            expiresIn: '24h',
+                        },
+                    );
+                    return `spacea?jwt_token=${token}`;
+                })(),
+                run: waitForCookiesDialog,
+            },
+            {
+                name: 'Space B',
+                url: (() => {
+                    const privateKey = 'af5688dc-f0b6-4146-9b1d-6d834c62c980';
+                    const token = jwt.sign(
+                        {
+                            name: 'gitbook-open-tests',
+                        },
+                        privateKey,
+                        {
+                            expiresIn: '24h',
+                        },
+                    );
+                    return `spaceb?jwt_token=${token}`;
+                })(),
+                run: waitForCookiesDialog,
+            },
+            {
+                name: 'Space C',
+                url: (() => {
+                    const privateKey = 'af5688dc-f0b6-4146-9b1d-6d834c62c980';
+                    const token = jwt.sign(
+                        {
+                            name: 'gitbook-open-tests',
+                        },
+                        privateKey,
+                        {
+                            expiresIn: '24h',
+                        },
+                    );
+                    return `spacec?jwt_token=${token}`;
+                })(),
+                run: waitForCookiesDialog,
+            },
+        ],
+    },
+    {
+        name: 'Visitor Auth - Space (custom domain)',
+        baseUrl: `https://test.gitbook.community/`,
+        tests: [
+            {
+                name: 'Root',
+                url: (() => {
+                    const privateKey = '19c8166f-c436-4ed1-a24e-60954b804021';
+                    const token = jwt.sign(
+                        {
+                            name: 'gitbook-open-tests',
+                        },
+                        privateKey,
+                        {
+                            expiresIn: '24h',
+                        },
+                    );
+                    return `?jwt_token=${token}`;
+                })(),
+                run: waitForCookiesDialog,
+            },
+            {
+                name: 'First',
+                url: (() => {
+                    const privateKey = '19c8166f-c436-4ed1-a24e-60954b804021';
+                    const token = jwt.sign(
+                        {
+                            name: 'gitbook-open-tests',
+                        },
+                        privateKey,
+                        {
+                            expiresIn: '24h',
+                        },
+                    );
+                    return `first?jwt_token=${token}`;
+                })(),
+                run: waitForCookiesDialog,
+            },
+            {
+                name: 'Custom page',
+                url: (() => {
+                    const privateKey = '19c8166f-c436-4ed1-a24e-60954b804021';
+                    const token = jwt.sign(
+                        {
+                            name: 'gitbook-open-tests',
+                        },
+                        privateKey,
+                        {
+                            expiresIn: '24h',
+                        },
+                    );
+                    return `custom-page?jwt_token=${token}`;
+                })(),
+                run: waitForCookiesDialog,
+            },
+            {
+                name: 'Inner page',
+                url: (() => {
+                    const privateKey = '19c8166f-c436-4ed1-a24e-60954b804021';
+                    const token = jwt.sign(
+                        {
+                            name: 'gitbook-open-tests',
+                        },
+                        privateKey,
+                        {
+                            expiresIn: '24h',
+                        },
+                    );
+                    return `custom-page/inner-page?jwt_token=${token}`;
+                })(),
+                run: waitForCookiesDialog,
+            },
+        ],
+    },
+    {
+        name: 'Languages',
+        baseUrl: 'https://gitbook.gitbook.io/test-gitbook-open/',
+        tests: allLocales.map((locale) => ({
+            name: locale,
+            url: getCustomizationURL({
+                internationalization: {
+                    locale,
+                },
+            }),
+            run: async (page) => {
+                const dialog = page.getByTestId('cookies-dialog');
+                await expect(dialog).toBeVisible();
+            },
+        })),
+    },
+    {
+        name: 'SEO',
+        baseUrl: 'https://gitbook.gitbook.io/test-gitbook-open/',
+        tests: [
+            {
+                name: `Index by default`,
+                url: '?x-gitbook-search-indexation=true',
+                screenshot: false,
+                run: async (page) => {
+                    const metaRobots = page.locator('meta[name="robots"]');
+                    await expect(metaRobots).toHaveAttribute('content', 'index, follow');
+                },
+            },
+            {
+                name: `Don't index noIndex`,
+                url: 'page-options/page-no-index?x-gitbook-search-indexation=true',
+                screenshot: false,
+                run: async (page) => {
+                    const metaRobots = page.locator('meta[name="robots"]');
+                    await expect(metaRobots).toHaveAttribute('content', 'noindex, nofollow');
+                },
+            },
+            {
+                name: `Don't index descendant of noIndex`,
+                url: 'page-options/page-no-index/descendant-of-page-no-index?x-gitbook-search-indexation=true',
+                screenshot: false,
+                run: async (page) => {
+                    const metaRobots = page.locator('meta[name="robots"]');
+                    await expect(metaRobots).toHaveAttribute('content', 'noindex, nofollow');
+                },
+            },
+            {
+                name: `Don't index noRobotsIndex`,
+                url: 'page-options/page-no-robots-index?x-gitbook-search-indexation=true',
+                screenshot: false,
+                run: async (page) => {
+                    const metaRobots = page.locator('meta[name="robots"]');
+                    await expect(metaRobots).toHaveAttribute('content', 'noindex, nofollow');
+                },
+            },
+            {
+                name: `Don't index descendant of noRobotsIndex`,
+                url: 'page-options/page-no-robots-index/descendant-of-page-no-robots-index?x-gitbook-search-indexation=true',
+                screenshot: false,
+                run: async (page) => {
+                    const metaRobots = page.locator('meta[name="robots"]');
+                    await expect(metaRobots).toHaveAttribute('content', 'noindex, nofollow');
+                },
+            },
+        ],
+    },
+];
+
+for (const testCase of testCases) {
+    test.describe(testCase.name, () => {
+        for (const testEntry of testCase.tests) {
+            const testFn = testEntry.only ? test.only : test;
+            testFn(testEntry.name, async ({ page, baseURL }) => {
+                const contentUrl = new URL(testEntry.url, testCase.baseUrl);
+                const url = getContentTestURL(contentUrl.toString(), baseURL);
+                await page.goto(url);
+                if (testEntry.run) {
+                    await testEntry.run(page);
+                }
+                if (testEntry.screenshot !== false) {
+                    await argosScreenshot(page, `${testCase.name} - ${testEntry.name}`, {
+                        viewports: ['macbook-16', 'macbook-13', 'iphone-x', 'ipad-2'],
+                        argosCSS: `
+                        /* Hide Intercom */
+                        .intercom-lightweight-app {
+                            display: none !important;
+                        }
+                    `,
+                        fullPage: testEntry.fullPage ?? false,
+                    });
+                }
+            });
+        }
+    });
+}
+
+/**
+ * Create a URL with customization settings.
+ */
+function getCustomizationURL(partial: DeepPartial<SiteCustomizationSettings>): string {
+    const encoded = rison.encode_object(partial);
+
+    const searchParams = new URLSearchParams();
+    searchParams.set('customization', encoded);
+
+    return `?${searchParams.toString()}`;
+}

packages/gitbook/e2e/util.ts

@@ -1,332 +0,0 @@
-import { argosScreenshot } from '@argos-ci/playwright';
-import {
-    CustomizationBackground,
-    CustomizationCorners,
-    CustomizationFont,
-    CustomizationHeaderItem,
-    CustomizationHeaderPreset,
-    CustomizationIconsStyle,
-    CustomizationLocale,
-    CustomizationSidebarBackgroundStyle,
-    CustomizationSidebarListStyle,
-    CustomizationTheme,
-    CustomizationThemedColor,
-    CustomizationThemeMode,
-    SiteCustomizationSettings,
-} from '@gitbook/api';
-import { test, expect, Page, BrowserContext } from '@playwright/test';
-import deepMerge from 'deepmerge';
-import rison from 'rison';
-import { DeepPartial } from 'ts-essentials';
-
-import { getContentTestURL } from '../tests/utils';
-
-export interface Test {
-    name: string;
-    /**
-     * URL to visit for testing.
-     */
-    url: string;
-    cookies?: Parameters<BrowserContext['addCookies']>[0];
-    /**
-     * Test to run
-     */
-    run?: (page: Page) => Promise<unknown>;
-    /**
-     * Whether the test should be fullscreened during testing.
-     */
-    fullPage?: boolean;
-    /**
-     * Whether to take a screenshot of the test or set a threshold for the screenshot.
-     */
-    screenshot?:
-        | false
-        | {
-              /**
-               * Screenshot threshold.
-               * From 0 to 1, where 0 is the most strict and 1 is the most permissive.
-               * @default 0.5
-               */
-              threshold?: number;
-              /**
-               * Whether to wait for the table of contents to finish scrolling before taking the screenshot.
-               */
-              waitForTOCScrolling?: boolean;
-          };
-    /**
-     * Whether to only run this test.
-     */
-    only?: boolean;
-}
-
-export interface TestsCase {
-    name: string;
-    baseUrl: string;
-    tests: Array<Test>;
-}
-
-export const allLocales: CustomizationLocale[] = [
-    CustomizationLocale.Fr,
-    CustomizationLocale.Es,
-    CustomizationLocale.Ja,
-    CustomizationLocale.Zh,
-];
-
-export const allThemeModes: CustomizationThemeMode[] = [
-    CustomizationThemeMode.Light,
-    CustomizationThemeMode.Dark,
-];
-
-export const allTintColors: Array<{
-    label: string;
-    value: CustomizationThemedColor | undefined;
-}> = [
-    {
-        label: 'Off',
-        value: undefined,
-    },
-    { label: 'Primary', value: { light: '#346DDB', dark: '#346DDB' } },
-    { label: 'Custom', value: { light: '#C62C68', dark: '#EF96B8' } },
-];
-
-export const allThemes: CustomizationTheme[] = [
-    CustomizationTheme.Clean,
-    CustomizationTheme.Muted,
-    CustomizationTheme.Bold,
-    CustomizationTheme.Gradient,
-];
-
-export const allDeprecatedThemePresets: CustomizationHeaderPreset[] = [
-    CustomizationHeaderPreset.Default,
-    CustomizationHeaderPreset.Bold,
-    CustomizationHeaderPreset.Contrast,
-    CustomizationHeaderPreset.Custom,
-];
-
-export const allSidebarBackgroundStyles: CustomizationSidebarBackgroundStyle[] = [
-    CustomizationSidebarBackgroundStyle.Default,
-    CustomizationSidebarBackgroundStyle.Filled,
-];
-
-// Common customization settings
-
-export const headerLinks: CustomizationHeaderItem[] = [
-    {
-        title: 'Secondary button',
-        to: { kind: 'url', url: 'https://www.gitbook.com' },
-        style: 'button-secondary',
-        links: [],
-    },
-    {
-        title: 'Primary button',
-        to: { kind: 'url', url: 'https://www.gitbook.com' },
-        style: 'button-primary',
-        links: [],
-    },
-];
-
-export async function waitForCookiesDialog(page: Page) {
-    const dialog = page.getByRole('dialog', { name: 'Cookies' });
-    const accept = dialog.getByRole('button', { name: 'Accept' });
-    const reject = dialog.getByRole('button', { name: 'Reject' });
-    await expect(accept).toBeVisible();
-    await expect(reject).toBeVisible();
-}
-
-/**
- * Transform test cases into Playwright tests and run it.
- */
-export function runTestCases(testCases: TestsCase[]) {
-    for (const testCase of testCases) {
-        test.describe(testCase.name, () => {
-            for (const testEntry of testCase.tests) {
-                const testFn = testEntry.only ? test.only : test;
-                testFn(testEntry.name, async ({ page, baseURL, context }) => {
-                    const contentUrl = new URL(testEntry.url, testCase.baseUrl);
-                    const url = getContentTestURL(contentUrl.toString(), baseURL);
-                    if (testEntry.cookies) {
-                        await context.addCookies(
-                            testEntry.cookies.map((cookie) => ({
-                                ...cookie,
-                                domain: new URL(url).host,
-                                path: '/',
-                            })),
-                        );
-                    }
-                    await page.goto(url);
-                    if (testEntry.run) {
-                        await testEntry.run(page);
-                    }
-                    const screenshotOptions = testEntry.screenshot;
-                    if (screenshotOptions !== false) {
-                        await argosScreenshot(page, `${testCase.name} - ${testEntry.name}`, {
-                            viewports: ['macbook-16', 'macbook-13', 'ipad-2', 'iphone-x'],
-                            argosCSS: `
-                        /* Hide Intercom */
-                        .intercom-lightweight-app {
-                            display: none !important;
-                            }
-                            `,
-                            threshold: screenshotOptions?.threshold ?? undefined,
-                            fullPage: testEntry.fullPage ?? false,
-                            beforeScreenshot: async () => {
-                                await waitForIcons(page);
-                                if (screenshotOptions?.waitForTOCScrolling !== false) {
-                                    await waitForTOCScrolling(page);
-                                }
-                            },
-                        });
-                    }
-                });
-            }
-        });
-    }
-}
-
-/**
- * Create a URL with customization settings.
- */
-export function getCustomizationURL(partial: DeepPartial<SiteCustomizationSettings>): string {
-    // We replicate the theme migration logic from the API to the tests, because the don't get these settings from the API.
-    // We can remove this once the migration to the new themes have been completed and the new theme styles are verified
-    // Map the theme preset (+ tint) to one of the new themes
-    const newTheme = (() => {
-        if (partial.styling?.theme) {
-            return partial.styling.theme;
-        }
-
-        switch (partial.header?.preset) {
-            case CustomizationHeaderPreset.Bold:
-            case CustomizationHeaderPreset.Contrast:
-            case CustomizationHeaderPreset.Custom:
-                return CustomizationTheme.Bold;
-
-            case CustomizationHeaderPreset.None:
-            case CustomizationHeaderPreset.Default:
-                if (partial.styling?.tint) {
-                    return CustomizationTheme.Muted;
-                }
-
-                return CustomizationTheme.Clean;
-            default:
-                return CustomizationTheme.Clean;
-        }
-    })();
-
-    /**
-     * Default customization settings.
-     *
-     * The customization object passed to the URL should be a valid API settings object. Hence we extend the test with necessary defaults.
-     */
-    const DEFAULT_CUSTOMIZATION: SiteCustomizationSettings = {
-        styling: {
-            theme: newTheme,
-            primaryColor: { light: '#346DDB', dark: '#346DDB' },
-            corners: CustomizationCorners.Rounded,
-            font: CustomizationFont.Inter,
-            background: CustomizationBackground.Plain,
-            icons: CustomizationIconsStyle.Regular,
-            sidebar: {
-                background: CustomizationSidebarBackgroundStyle.Default,
-                list: CustomizationSidebarListStyle.Default,
-            },
-        },
-        internationalization: {
-            locale: CustomizationLocale.En,
-        },
-        favicon: {},
-        header: {
-            preset: CustomizationHeaderPreset.Default,
-            links: [],
-        },
-        footer: {
-            groups: [],
-        },
-        themes: {
-            default: CustomizationThemeMode.Light,
-            toggeable: true,
-        },
-        pdf: {
-            enabled: true,
-        },
-        feedback: {
-            enabled: false,
-        },
-        aiSearch: {
-            enabled: true,
-        },
-        advancedCustomization: {
-            enabled: true,
-        },
-        git: {
-            showEditLink: false,
-        },
-        pagination: {
-            enabled: true,
-        },
-        trademark: {
-            enabled: true,
-        },
-        privacyPolicy: {
-            url: 'https://www.gitbook.com/privacy',
-        },
-        socialPreview: {},
-    };
-
-    const encoded = rison.encode_object(deepMerge(DEFAULT_CUSTOMIZATION, partial));
-
-    const searchParams = new URLSearchParams();
-    searchParams.set('customization', encoded);
-
-    return `?${searchParams.toString()}`;
-}
-
-/**
- * Wait for all icons present on the page to be loaded.
- */
-async function waitForIcons(page: Page) {
-    await page.waitForFunction(async () => {
-        function loadImage(src: string) {
-            return new Promise((resolve, reject) => {
-                const img = new Image();
-                img.onload = () => resolve(img);
-                img.onerror = (error) => reject(new Error(`Failed to load image: ${src}`));
-                img.src = src;
-            });
-        }
-
-        const icons = Array.from(document.querySelectorAll('svg.gb-icon'));
-        await Promise.all(
-            icons.map(async (icon) => {
-                // url("https://ka-p.fontawesome.com/releases/v6.6.0/svgs/light/moon.svg?v=2&token=a463935e93")
-                const maskImage = window.getComputedStyle(icon).getPropertyValue('mask-image');
-                const urlMatch = maskImage.match(/url\("([^"]+)"\)/);
-                const url = urlMatch ? urlMatch[1] : null;
-                if (!url) {
-                    throw new Error('No mask-image');
-                }
-                await loadImage(url);
-            }),
-        );
-    });
-}
-
-/**
- * Wait for TOC to be correctly scrolled into view.
- */
-async function waitForTOCScrolling(page: Page) {
-    const viewport = await page.viewportSize();
-    if (viewport && viewport.width >= 1024) {
-        const toc = page.getByTestId('table-of-contents');
-        await expect(toc).toBeVisible();
-        await page.evaluate(() => {
-            const tocScrollContainer = document.querySelector(
-                '[data-testid="table-of-contents"] [data-testid="toc-scroll-container"]',
-            );
-            if (!tocScrollContainer) {
-                throw new Error('TOC scroll container not found');
-            }
-            tocScrollContainer.scrollTo(0, 0);
-        });
-    }
-}

packages/gitbook/next.config.js

@@ -4,13 +4,11 @@ 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 }) {
@@ -69,15 +67,19 @@ module.exports = withSentryConfig(
         },
     },
     {
-        release: process.env.SENTRY_RELEASE,
+        silent: true,
         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,37 +1,34 @@
 {
     "name": "gitbook",
-    "version": "0.6.1",
+    "version": "0.3.0",
     "private": true,
     "scripts": {
         "dev": "env-cmd --silent -f ../../.env.local next dev",
         "build": "next build",
-        "build:cloudflare": "next-on-pages --custom-entrypoint=./src/cloudflare-entrypoint.ts",
+        "build:cloudflare": "next-on-pages",
         "start": "next start",
         "lint": "next lint",
         "typecheck": "tsc --noEmit",
-        "e2e": "playwright test e2e/internal.spec.ts",
-        "e2e-customers": "playwright test e2e/customers.spec.ts",
+        "e2e": "playwright test",
         "unit": "bun test {src,packages}",
         "generate": "gitbook-icons ./public/~gitbook/static/icons custom-icons && gitbook-math ./public/~gitbook/static/math",
         "copy:icons": "gitbook-icons ./public/~gitbook/static/icons",
-        "clean": "rm -rf ./.next && rm -rf ./public/~gitbook/static/icons && rm -rf ./public/~gitbook/static/math"
+        "clean": "rm -rf ./.next && rm -rf ./public/~gitbook/static"
     },
     "dependencies": {
-        "@gitbook/api": "^0.93.0",
+        "@gitbook/api": "0.64.1",
         "@gitbook/cache-do": "workspace:*",
         "@gitbook/emoji-codepoints": "workspace:*",
         "@gitbook/icons": "workspace:*",
-        "@gitbook/openapi-parser": "workspace:*",
         "@gitbook/react-contentkit": "workspace:*",
         "@gitbook/react-math": "workspace:*",
         "@gitbook/react-openapi": "workspace:*",
         "@radix-ui/react-checkbox": "^1.0.4",
-        "@radix-ui/react-navigation-menu": "^1.2.3",
         "@radix-ui/react-popover": "^1.0.7",
-        "@sentry/nextjs": "8.35.0",
+        "@sentry/nextjs": "^7.94.1",
         "@sindresorhus/fnv1a": "^3.1.0",
         "@tailwindcss/container-queries": "^0.1.1",
-        "@tailwindcss/typography": "^0.5.16",
+        "@tailwindcss/typography": "^0.5.10",
         "@upstash/redis": "^1.27.1",
         "ajv": "^8.12.0",
         "assert-never": "^1.2.1",
@@ -43,18 +40,19 @@
         "jsontoxml": "^1.0.1",
         "katex": "^0.16.9",
         "mathjax": "^3.2.2",
-        "mdast-util-to-markdown": "^2.1.2",
         "memoizee": "^0.4.15",
-        "next": "14.2.23",
+        "next": "^14.2.5",
         "next-themes": "^0.2.1",
-        "nuqs": "^2.2.3",
+        "nuqs": "^1.17.4",
         "object-hash": "^3.0.0",
         "openapi-types": "^12.1.3",
         "p-map": "^7.0.0",
         "parse-cache-control": "^1.0.1",
-        "react": "18.3.1",
-        "react-dom": "18.3.1",
+        "postcss-color-contrast": "^1.1.0",
+        "react": "^18",
+        "react-dom": "^18",
         "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",
@@ -62,33 +60,28 @@
         "remark-rehype": "^11.1.0",
         "rison": "^0.1.1",
         "server-only": "^0.0.1",
-        "shiki": "^1.27.2",
+        "shiki": "^1.11.1",
         "tailwind-merge": "^2.2.0",
         "tailwind-shades": "^1.1.2",
         "unified": "^11.0.4",
-        "url-join": "^5.0.0",
-        "usehooks-ts": "^3.1.0"
+        "url-join": "^5.0.0"
     },
     "devDependencies": {
-        "@argos-ci/playwright": "^3.10.0",
-        "@cloudflare/next-on-pages": "1.13.7",
-        "vercel": "^39.3.0",
-        "@cloudflare/workers-types": "^4.20241230.0",
-        "@playwright/test": "^1.49.1",
+        "@argos-ci/playwright": "^2.0.0",
+        "@playwright/test": "^1.42.1",
+        "@cloudflare/next-on-pages": "^1.13.3",
+        "@cloudflare/workers-types": "^4.20240725.0",
         "@types/js-cookie": "^3.0.6",
         "@types/jsontoxml": "^1.0.5",
         "@types/jsonwebtoken": "^9.0.6",
-        "@types/mdast": "^4.0.4",
         "@types/node": "^20",
         "@types/object-hash": "^3.0.6",
         "@types/parse-cache-control": "^1.0.4",
         "@types/psi": "^4.1.6",
-        "@types/react": "18.3.13",
-        "@types/react-dom": "18.3.1",
+        "@types/react": "^18.3.3",
+        "@types/react-dom": "^18.3.0",
         "@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",
@@ -96,7 +89,8 @@
         "postcss": "^8",
         "psi": "^4.1.0",
         "tailwindcss": "^3.4.0",
-        "ts-essentials": "^10.0.1",
-        "typescript": "^5.5.3"
+        "typescript": "^5.5.3",
+        "env-cmd": "^10.1.0",
+        "ts-essentials": "^10.0.1"
     }
 }