Version Packages (#2988)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

.bun-version

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

.github/composite/deploy-cloudflare/action.yaml

@@ -0,0 +1,72 @@
+name: 'Deploy cloudflare'
+description: 'Deploy GitBook to Cloudflare'
+inputs:
+  opItem:
+    description: '1Password item to load secrets from'
+    required: true
+  opServiceAccount:
+    description: '1Password service account token'
+    required: true
+  apiToken:
+    description: 'Cloudflare API token'
+    required: true
+  accountId:
+    description: 'Cloudflare account ID'
+    required: true
+  environment:
+    description: 'Cloudflare environment to deploy to (staging, production, preview)'
+    required: true
+  deploy:
+    description: 'Deploy as main version for all traffic instead of uploading versions'
+    required: true
+outputs:
+    deployment-url: 
+      description: "Deployment URL"
+      value: ${{ steps.deploy.outputs.deployment-url }}
+runs:
+    using: 'composite'
+    steps:
+        - name: Setup Bun
+          uses: ./.github/composite/setup-bun
+        - name: Install dependencies
+          run: bun install --frozen-lockfile
+          shell: bash
+          env:
+              PUPPETEER_SKIP_DOWNLOAD: 1
+        - name: Load secret
+          uses: 1password/load-secrets-action@v2
+          env:
+            OP_SERVICE_ACCOUNT_TOKEN: ${{ inputs.opServiceAccount }}
+            GITBOOK_URL: ${{ inputs.opItem }}/GITBOOK_URL
+            GITBOOK_ICONS_URL: ${{ inputs.opItem }}/GITBOOK_ICONS_URL
+            GITBOOK_ICONS_TOKEN: ${{ inputs.opItem }}/GITBOOK_ICONS_TOKEN
+            NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: ${{ inputs.opItem }}/NEXT_SERVER_ACTIONS_ENCRYPTION_KEY
+            GITBOOK_SECRET: ${{ inputs.opItem }}/GITBOOK_SECRET
+            GITBOOK_APP_URL: ${{ inputs.opItem }}/GITBOOK_APP_URL
+            GITBOOK_API_URL: ${{ inputs.opItem }}/GITBOOK_API_URL
+            GITBOOK_API_PUBLIC_URL: ${{ inputs.opItem }}/GITBOOK_API_PUBLIC_URL
+            GITBOOK_API_TOKEN: ${{ inputs.opItem }}/GITBOOK_API_TOKEN
+            GITBOOK_INTEGRATIONS_HOST: ${{ inputs.opItem }}/GITBOOK_INTEGRATIONS_HOST
+            GITBOOK_IMAGE_RESIZE_SIGNING_KEY: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_SIGNING_KEY
+            GITBOOK_IMAGE_RESIZE_URL: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_URL
+            GITBOOK_ASSETS_PREFIX: ${{ inputs.opItem }}/GITBOOK_ASSETS_PREFIX
+            GITBOOK_FONTS_URL: ${{ inputs.opItem }}/GITBOOK_FONTS_URL
+        - name: Build worker
+          run: bun run turbo build:v2:cloudflare
+          shell: bash
+        - id: deploy
+          name: Deploy to Cloudflare
+          uses: cloudflare/wrangler-action@v3.14.0
+          with:
+              apiToken: ${{ inputs.apiToken }}
+              accountId: ${{ inputs.accountId }}
+              workingDirectory: ./
+              wranglerVersion: '3.112.0'
+              environment: ${{ inputs.environment }}
+              command: ${{ fromJSON(inputs.deploy) == true && 'deploy' || 'versions upload' }} --config ./packages/gitbook-v2/wrangler.toml
+        - name: Outputs
+          shell: bash
+          env:
+            DEPLOYMENT_URL: ${{ steps.deploy.outputs.deployment-url }}
+          run: |
+              echo "URL: ${{ steps.deploy.outputs.deployment-url }}"

.github/composite/deploy-vercel/action.yaml

@@ -0,0 +1,78 @@
+name: 'Deploy vercel'
+description: 'Deploy GitBook to Vercel'
+inputs:
+  vercelOrg:
+    description: 'Vercel organization'
+    required: true
+  vercelProject:
+    description: 'Vercel project'
+    required: true
+  vercelToken:
+    description: 'Vercel token'
+    required: true
+  opItem:
+    description: '1Password item to load secrets from'
+    required: true
+  opServiceAccount:
+    description: '1Password service account token'
+    required: true
+  environment:
+    description: 'Environment to deploy to'
+    required: true
+outputs:
+    deployment-url: 
+      description: "Deployment URL"
+      value: ${{ steps.deploy.outputs.deployment-url }}
+runs:
+    using: 'composite'
+    steps:
+        - name: Setup Bun
+          uses: ./.github/composite/setup-bun
+        - name: Install dependencies
+          run: bun install --frozen-lockfile
+          shell: bash
+          env:
+              PUPPETEER_SKIP_DOWNLOAD: 1
+        - name: Pull Vercel Environment Information
+          run: bun run vercel pull --yes --environment=${{ inputs.environment }} --token=${{ inputs.vercelToken }}
+          shell: bash
+          env:
+            VERCEL_ORG_ID: ${{ inputs.vercelOrg }}
+            VERCEL_PROJECT_ID: ${{ inputs.vercelProject }}
+        - name: Load secret
+          uses: 1password/load-secrets-action@v2
+          env:
+            OP_SERVICE_ACCOUNT_TOKEN: ${{ inputs.opServiceAccount }}
+            GITBOOK_URL: ${{ inputs.opItem }}/GITBOOK_URL
+            GITBOOK_ICONS_URL: ${{ inputs.opItem }}/GITBOOK_ICONS_URL
+            GITBOOK_ICONS_TOKEN: ${{ inputs.opItem }}/GITBOOK_ICONS_TOKEN
+            GITBOOK_SECRET: ${{ inputs.opItem }}/GITBOOK_SECRET
+            GITBOOK_APP_URL: ${{ inputs.opItem }}/GITBOOK_APP_URL
+            GITBOOK_API_URL: ${{ inputs.opItem }}/GITBOOK_API_URL
+            GITBOOK_API_PUBLIC_URL: ${{ inputs.opItem }}/GITBOOK_API_PUBLIC_URL
+            GITBOOK_API_TOKEN: ${{ inputs.opItem }}/GITBOOK_API_TOKEN
+            GITBOOK_INTEGRATIONS_HOST: ${{ inputs.opItem }}/GITBOOK_INTEGRATIONS_HOST
+            GITBOOK_IMAGE_RESIZE_SIGNING_KEY: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_SIGNING_KEY
+            GITBOOK_IMAGE_RESIZE_URL: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_URL
+            GITBOOK_ASSETS_PREFIX: ${{ inputs.opItem }}/GITBOOK_ASSETS_PREFIX
+            GITBOOK_FONTS_URL: ${{ inputs.opItem }}/GITBOOK_FONTS_URL
+        - name: Build Project Artifacts
+          run: bun run vercel build --target=${{ inputs.environment }} --token=${{ inputs.vercelToken }}
+          shell: bash
+          env:
+            VERCEL_ORG_ID: ${{ inputs.vercelOrg }}
+            VERCEL_PROJECT_ID: ${{ inputs.vercelProject }}
+        - name: Deploy Project Artifacts to Vercel
+          id: deploy
+          shell: bash
+          run: |
+              DEPLOYMENT_URL=$(bun run vercel deploy --prebuilt --target=${{ inputs.environment }} --token=${{ inputs.vercelToken }})
+              echo "deployment-url=$DEPLOYMENT_URL" >> "$GITHUB_OUTPUT"
+          env:
+            VERCEL_ORG_ID: ${{ inputs.vercelOrg }}
+            VERCEL_PROJECT_ID: ${{ inputs.vercelProject }}
+        - name: Outputs
+          shell: bash
+          run: |
+              echo "URL: ${{ steps.deploy.outputs.deployment-url }}"
+

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

@@ -3,16 +3,7 @@ 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'
+              bun-version-file: 'package.json'

.github/workflows/ci.yaml

@@ -7,300 +7,10 @@ on:
 env:
     NPM_TOKEN_READONLY: ${{ secrets.NPM_TOKEN_READONLY }}
 jobs:
-    deploy:
-        name: Deploy to Cloudflare Pages
-        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 }}
-            deployment-alias-url: ${{ steps.deploy.outputs.deployment-alias-url }}
-        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 Next.js with next-on-pages
-              run: bun run turbo gitbook#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.14.0
-              with:
-                  apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
-                  accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
-                  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 }}"
-            - 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_URL=https://open-2v.gitbook.com" >> $GITHUB_ENV
-                  echo "GITBOOK_ASSETS_PREFIX=https://static-2v.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 --target=$VERCEL_ENVIRONMENT $([ "$VERCEL_ENVIRONMENT" = "production" ] && echo "--prod") --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_URL=https://open-2c.gitbook.com" >> $GITHUB_ENV
-                  echo "GITBOOK_ASSETS_PREFIX=https://static-2c.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.14.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 }}/url/docs.gitbook.com](${{ needs.deploy-v2-vercel.outputs.deployment-url }}/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 }}/url/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open) |
-                  edit-mode: replace
-    visual-testing:
-        runs-on: ubuntu-latest
-        name: Visual Testing
-        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
-              env:
-                  BASE_URL: ${{needs.deploy.outputs.deployment-url}}
-                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
-            - uses: actions/upload-artifact@v4
-              if: ${{ !cancelled() }}
-              with:
-                  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
-        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
-              env:
-                  PUPPETEER_SKIP_DOWNLOAD: 1
-            - name: Run pagespeed tests
-              run: bun ./packages/gitbook/tests/pagespeed-testing.ts $DEPLOYMENT_URL
-              env:
-                  DEPLOYMENT_URL: ${{needs.deploy.outputs.deployment-url}}
-                  PAGESPEED_API_KEY: ${{ secrets.PAGESPEED_API_KEY }}
     format:
         runs-on: ubuntu-latest
         name: Format
+        timeout-minutes: 6
         steps:
             - name: Checkout
               uses: actions/checkout@v4
@@ -311,22 +21,10 @@ jobs:
               env:
                   PUPPETEER_SKIP_DOWNLOAD: 1
             - run: bun format:check
-    lint:
-        runs-on: ubuntu-latest
-        name: Lint
-        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
-            - run: bun lint --no-cache
     test:
         runs-on: ubuntu-latest
         name: Test
+        timeout-minutes: 6
         steps:
             - name: Checkout
               uses: actions/checkout@v4
@@ -341,6 +39,7 @@ jobs:
         # CI to check that the repository builds correctly on a machine without the credentials
         runs-on: ubuntu-latest
         name: Build (Open Source)
+        timeout-minutes: 6
         env:
             NPM_TOKEN_READONLY: ''
         steps:
@@ -356,6 +55,7 @@ jobs:
     typecheck:
         runs-on: ubuntu-latest
         name: Typecheck
+        timeout-minutes: 6
         steps:
             - name: Checkout
               uses: actions/checkout@v4

.github/workflows/deploy-preview.yaml

@@ -0,0 +1,245 @@
+name: Preview
+on:
+    pull_request:
+    push:
+      branches:
+        - main
+env:
+    NPM_TOKEN_READONLY: ${{ secrets.NPM_TOKEN_READONLY }}
+jobs:
+    deploy-v1-cloudflare:
+        name: Deploy v1 to Cloudflare Pages
+        runs-on: ubuntu-latest
+        environment: 
+          name: ${{ github.ref == 'refs/heads/main' && '1c-production' || '1c-preview' }}
+          url: ${{ steps.deploy.outputs.deployment-url }}
+        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 }}
+        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
+              if: github.ref == 'refs/heads/main'
+              run: |
+                echo "GITBOOK_ASSETS_PREFIX=https://static.gitbook.com" >> $GITHUB_ENV
+            - name: Build Next.js with next-on-pages
+              run: bun run turbo gitbook#build:cloudflare
+              env:
+                  NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: ${{ secrets.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY }}
+            - id: deploy
+              name: Deploy to Cloudflare
+              uses: cloudflare/wrangler-action@v3.14.0
+              with:
+                  apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+                  accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+                  workingDirectory: ./
+                  wranglerVersion: '3.112.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 }}"
+    deploy-v2-vercel:
+        name: Deploy v2 to Vercel (preview)
+        runs-on: ubuntu-latest
+        environment: 
+          name: 2v-preview
+          url: ${{ steps.deploy.outputs.deployment-url }}
+        outputs:
+            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Deploy to Vercel
+              id: deploy
+              uses: ./.github/composite/deploy-vercel
+              with:
+                  environment: preview
+                  vercelOrg: ${{ secrets.VERCEL_ORG_ID }}
+                  vercelProject: ${{ secrets.VERCEL_PROJECT_ID }}
+                  vercelToken: ${{ secrets.VERCEL_TOKEN }}
+                  opItem: op://gitbook-open/2v-preview
+                  opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
+    deploy-v2-cloudflare:
+        name: Deploy v2 to Cloudflare Worker (preview)
+        runs-on: ubuntu-latest
+        environment: 
+          name: 2c-preview
+          url: ${{ steps.deploy.outputs.deployment-url }}
+        outputs:
+            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Deploy to Cloudflare
+              id: deploy
+              uses: ./.github/composite/deploy-cloudflare
+              with:
+                  environment: preview
+                  deploy: ${{ github.ref == 'refs/heads/main' }}
+                  apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+                  accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+                  opItem: op://gitbook-open/2c-preview
+                  opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
+            - name: Outputs
+              run: |
+                  echo "URL: ${{ steps.deploy.outputs.deployment-url }}"
+    comment-deployments:
+        runs-on: ubuntu-latest
+        name: Comment Deployments (preview)
+        if: always() && !startsWith(github.ref, 'refs/heads/main')
+        needs:
+            - deploy-v1-cloudflare
+            - 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-v1-cloudflare.outputs.deployment-url }}](${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}) | ${{ needs.deploy-v1-cloudflare.result == 'success' && '✅' || '❌' }} |
+                      | PR | [${{ needs.deploy-v1-cloudflare.outputs.deployment-alias-url }}](${{ needs.deploy-v1-cloudflare.outputs.deployment-alias-url }}) | ${{ needs.deploy-v1-cloudflare.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-v1-cloudflare.outputs.deployment-url }}/docs.gitbook.com](${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}/docs.gitbook.com) | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/docs.gitbook.com](${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/docs.gitbook.com) |
+                      | E2E | [${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}/gitbook.gitbook.io/test-gitbook-open) | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open) |
+                  edit-mode: replace
+    visual-testing-v1:
+        runs-on: ubuntu-latest
+        name: Visual Testing v1
+        needs: deploy-v1-cloudflare
+        timeout-minutes: 8
+        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
+              env:
+                  BASE_URL: ${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}
+                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
+    visual-testing-v2-vercel:
+        runs-on: ubuntu-latest
+        name: Visual Testing v2
+        needs: deploy-v2-vercel
+        timeout-minutes: 10
+        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
+              env:
+                  BASE_URL: ${{ needs.deploy-v2-vercel.outputs.deployment-url }}
+                  SITE_BASE_URL: ${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/
+                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
+                  ARGOS_BUILD_NAME: 'v2-vercel'
+    visual-testing-customers-v1:
+        runs-on: ubuntu-latest
+        name: Visual Testing Customers v1
+        needs: deploy-v1-cloudflare
+        timeout-minutes: 6
+        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-v1-cloudflare.outputs.deployment-url }}
+                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
+                  ARGOS_BUILD_NAME: 'customers-v1'
+    visual-testing-customers-v2:
+        runs-on: ubuntu-latest
+        name: Visual Testing Customers v2
+        needs: deploy-v2-vercel
+        timeout-minutes: 6
+        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-v2-vercel.outputs.deployment-url }}
+                  SITE_BASE_URL: ${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/
+                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
+                  ARGOS_BUILD_NAME: 'customers-v2'
+    pagespeed-testing-v1:
+        runs-on: ubuntu-latest
+        name: PageSpeed Testing v1
+        needs: deploy-v1-cloudflare
+        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: Run pagespeed tests
+              run: bun ./packages/gitbook/tests/pagespeed-testing.ts
+              env:
+                  BASE_URL: ${{needs.deploy-v1-cloudflare.outputs.deployment-url}}
+                  PAGESPEED_API_KEY: ${{ secrets.PAGESPEED_API_KEY }}

.github/workflows/deploy-production.yaml

@@ -0,0 +1,53 @@
+name: Production
+on:
+    push:
+        branches:
+            - main
+env:
+    NPM_TOKEN_READONLY: ${{ secrets.NPM_TOKEN_READONLY }}
+jobs:
+    deploy-v2-vercel:
+        name: Deploy v2 to Vercel (production)
+        runs-on: ubuntu-latest
+        environment: 
+            name: 2v-production
+            url: ${{ steps.deploy.outputs.deployment-url }}
+        outputs:
+            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Deploy staging
+              id: deploy
+              uses: ./.github/composite/deploy-vercel
+              with:
+                environment: production
+                vercelOrg: ${{ secrets.VERCEL_ORG_ID }}
+                vercelProject: ${{ secrets.VERCEL_PROJECT_ID }}
+                vercelToken: ${{ secrets.VERCEL_TOKEN }}
+                opItem: op://gitbook-open/2v-production
+                opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
+    deploy-v2-cloudflare:
+        name: Deploy v2 to Cloudflare Worker (production)
+        runs-on: ubuntu-latest
+        environment: 
+            name: 2c-production
+            url: ${{ steps.deploy.outputs.deployment-url }}
+        outputs:
+            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Deploy
+              id: deploy
+              uses: ./.github/composite/deploy-cloudflare
+              with:
+                  environment: production
+                  deploy: true
+                  apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+                  accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+                  opItem: op://gitbook-open/2c-production
+                  opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
+            - name: Outputs
+              run: |
+                  echo "URL: ${{ steps.deploy.outputs.deployment-url }}"

.github/workflows/deploy-staging.yaml

@@ -0,0 +1,53 @@
+name: Staging
+on:
+    push:
+        branches:
+            - main
+env:
+    NPM_TOKEN_READONLY: ${{ secrets.NPM_TOKEN_READONLY }}
+jobs:
+    deploy-v2-vercel:
+        name: Deploy v2 to Vercel (staging)
+        runs-on: ubuntu-latest
+        environment: 
+            name: 2v-staging
+            url: ${{ steps.deploy.outputs.deployment-url }}
+        outputs:
+            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Deploy staging
+              id: deploy
+              uses: ./.github/composite/deploy-vercel
+              with:
+                environment: staging
+                vercelOrg: ${{ secrets.VERCEL_ORG_ID }}
+                vercelProject: ${{ secrets.VERCEL_PROJECT_ID }}
+                vercelToken: ${{ secrets.VERCEL_TOKEN }}
+                opItem: op://gitbook-open/2v-staging
+                opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
+    deploy-v2-cloudflare:
+        name: Deploy v2 to Cloudflare Worker (staging)
+        runs-on: ubuntu-latest
+        environment: 
+            name: 2c-staging
+            url: ${{ steps.deploy.outputs.deployment-url }}
+        outputs:
+            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Deploy
+              id: deploy
+              uses: ./.github/composite/deploy-cloudflare
+              with:
+                  environment: staging
+                  deploy: true
+                  apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+                  accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+                  opItem: op://gitbook-open/2c-staging
+                  opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
+            - name: Outputs
+              run: |
+                  echo "URL: ${{ steps.deploy.outputs.deployment-url }}"

.github/workflows/publish.yaml

@@ -5,6 +5,9 @@ on:
         branches:
             - main
 
+env:
+    NPM_TOKEN_READONLY: ${{ secrets.NPM_TOKEN_READONLY }}
+    
 concurrency: ${{ github.workflow }}-${{ github.ref }}
 
 jobs:
@@ -28,6 +31,7 @@ jobs:
               uses: changesets/action@v1
               with:
                   publish: npm run release
+                  version: npm run changeset-version
               env:
                   # Using a PAT instead of GITHUB_TOKEN because we need to run workflows when releases are created
                   # https://github.com/orgs/community/discussions/26875#discussioncomment-3253761

.prettierignore

@@ -1,17 +0,0 @@
-.next
-.vercel
-.open-next
-
-# Generated
-packages/emoji-codepoints/index.ts
-packages/gitbook/public/~gitbook/static/
-packages/icons/src/data/*.json
-
-# Build files
-dist/
-
-README.md
-CHANGELOG.md
-
-# v2
-packages/gitbook-v2/public/~gitbook/static/

.prettierrc.json

@@ -1,5 +0,0 @@
-{
-    "printWidth": 100,
-    "singleQuote": true,
-    "tabWidth": 4
-}

.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+    "recommendations": ["biomejs.biome"]
+}

.vscode/settings.json

@@ -7,5 +7,14 @@
         ["style \\=([^;]*);", "\"([^\"]*)\""],
         ["style \\=([^;]*);", "\\`([^\\`]*)\\`"]
     ],
-    "tailwindCSS.classAttributes": ["class", "className", "style", ".*Style"]
+    "tailwindCSS.classAttributes": ["class", "className", "style", ".*Style"],
+    "prettier.enable": false,
+    "editor.defaultFormatter": "biomejs.biome",
+    "editor.codeActionsOnSave": {
+        "source.organizeImports.biome": "explicit",
+        "source.fixAll.biome": "explicit"
+    },
+    "[typescript]": {
+        "editor.defaultFormatter": "biomejs.biome"
+    }
 }

biome.json

@@ -0,0 +1,175 @@
+{
+    "$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
+    "vcs": {
+        "enabled": false,
+        "clientKind": "git",
+        "useIgnoreFile": false
+    },
+    "files": {
+        "ignoreUnknown": false,
+        "ignore": [
+            "**/node_modules/**/*",
+            "**/dist/**/*",
+            "**/build/**/*",
+            "**/public/**/*",
+            "**/.next/**/*",
+            "**/.open-next/**/*",
+            "**/.turbo/**/*",
+            "**/.vercel/**/*",
+            "**/.cache/**/*",
+            "**/.wrangler/**/*",
+            "packages/openapi-parser/src/fixtures/**/*",
+            "packages/emoji-codepoints/index.ts",
+            "packages/icons/src/data/*.json"
+        ]
+    },
+    "formatter": {
+        "enabled": true,
+        "useEditorconfig": true,
+        "formatWithErrors": false,
+        "indentStyle": "space",
+        "indentWidth": 4,
+        "lineEnding": "lf",
+        "lineWidth": 100,
+        "attributePosition": "auto",
+        "bracketSpacing": true
+    },
+    "organizeImports": {
+        "enabled": true
+    },
+    "linter": {
+        "enabled": true,
+        "rules": {
+            "recommended": true,
+            "performance": {
+                "noDelete": "warn"
+            },
+            "security": {
+                "noDangerouslySetInnerHtml": "off"
+            },
+            "complexity": {
+                "noForEach": "off",
+                "noUselessFragments": "warn",
+                "noBannedTypes": "warn"
+            },
+            "correctness": {
+                "noUndeclaredVariables": "error",
+                "noUnusedVariables": "error",
+                "useArrayLiterals": "error",
+                "useHookAtTopLevel": "error",
+                "noUnusedImports": "error",
+                "noVoidElementsWithChildren": "warn",
+                "useJsxKeyInIterable": "warn",
+                "useExhaustiveDependencies": "warn",
+                "noUnknownFunction": "warn"
+            },
+            "style": {
+                "noNonNullAssertion": "warn",
+                "noParameterAssign": "off",
+                "useThrowOnlyError": "error"
+            },
+            "suspicious": {
+                "noConsole": {
+                    "level": "warn",
+                    "options": {
+                        "allow": ["assert", "error", "warn"]
+                    }
+                },
+                "noExplicitAny": "warn",
+                "noImplicitAnyLet": "warn",
+                "noConfusingVoidType": "warn",
+                "noControlCharactersInRegex": "warn",
+                "noPrototypeBuiltins": "warn",
+                "noAssignInExpressions": "warn",
+                "noArrayIndexKey": "warn"
+            },
+            "a11y": {
+                "useSemanticElements": "warn",
+                "useKeyWithClickEvents": "warn",
+                "noSvgWithoutTitle": "warn",
+                "useButtonType": "warn",
+                "useIframeTitle": "warn",
+                "useAltText": "warn",
+                "noPositiveTabindex": "warn",
+                "useFocusableInteractive": "warn",
+                "useAriaPropsForRole": "warn",
+                "useValidAnchor": "warn",
+                "noLabelWithoutControl": "warn",
+                "noNoninteractiveTabindex": "warn"
+            },
+            "nursery": {
+                "useSortedClasses": {
+                    "level": "error",
+                    "fix": "safe",
+                    "options": {
+                        "attributes": ["class", "className", "style"],
+                        "functions": ["clsx", "tw"]
+                    }
+                }
+            }
+        }
+    },
+    "javascript": {
+        "formatter": {
+            "jsxQuoteStyle": "double",
+            "quoteProperties": "asNeeded",
+            "trailingCommas": "es5",
+            "semicolons": "always",
+            "arrowParentheses": "always",
+            "bracketSameLine": false,
+            "quoteStyle": "single",
+            "attributePosition": "auto",
+            "bracketSpacing": true
+        }
+    },
+    "overrides": [
+        {
+            "include": [
+                "packages/gitbook/**/*",
+                "packages/gitbook-v2/**/*",
+                "packages/react-openapi/**/*",
+                "packages/react-math/**/*",
+                "packages/react-contentkit/**/*",
+                "packages/icons/**/*"
+            ],
+            "javascript": {
+                "globals": ["React"]
+            }
+        },
+        {
+            "include": ["packages/gitbook/**/*"],
+            "javascript": {
+                "globals": ["React", "GitBookIntegrationEvent"]
+            }
+        },
+        {
+            "include": ["*.css"],
+            "javascript": {
+                "globals": ["theme"]
+            }
+        },
+        {
+            "include": ["*.test.ts", "packages/gitbook/tests/**/*"],
+            "javascript": {
+                "globals": ["Bun"]
+            }
+        },
+        {
+            "include": [
+                "packages/cache-do/**/*",
+                "packages/gitbook/cf-env.d.ts",
+                "packages/gitbook/src/cloudflare-entrypoint.ts"
+            ],
+            "javascript": {
+                "globals": [
+                    "DurableObjectLocationHint",
+                    "DurableObjectNamespace",
+                    "DurableObjectStub",
+                    "ContinentCode",
+                    "Fetcher",
+                    "ExportedHandler"
+                ]
+            }
+        }
+    ]
+}

docs/caching.md

@@ -1,22 +0,0 @@
-# Caching
-
-## Revalidating the cache
-
-Invalidate cache can be done at two levels using tags:
-
--   Data fetching cache
--   Rendering cache
-
-To invalidate and refetch the data cache, you can execute a POST request to `/~/gitbook/revalidate`:
-
-```bash
-curl --location --request POST 'https://gitbook/mycompany.com/~gitbook/revalidate' \
---header 'Content-Type: application/json' \
---data-raw '{"tags": ["space.id"]}'
-```
-
-To invalidate the rendering cache, the implementation mainly depends on the infrastructure serving the content, GitBook outputs a `Cache-Tag` header on every requests. The value of the header is a comma separated list of tags.
-
-## Purging the cache
-
-Purging the cache, without revalidating, is done by passing `"purge": true` in the request body.

package.json

@@ -2,16 +2,17 @@
     "name": "gitbook",
     "version": "0.1.0",
     "devDependencies": {
+        "@biomejs/biome": "^1.9.4",
         "@changesets/cli": "^2.27.12",
-        "prettier": "^3.0.3",
+        "turbo": "^2.4.4",
-        "turbo": "^2.4.1-canary.2",
         "vercel": "^39.3.0"
     },
-    "packageManager": "bun@1.1.18",
+    "packageManager": "bun@1.2.5",
     "overrides": {
         "@codemirror/state": "6.4.1",
         "react": "18.3.1",
-        "react-dom": "18.3.1"
+        "react-dom": "18.3.1",
+        "@gitbook/api": "0.102.0"
     },
     "private": true,
     "scripts": {
@@ -20,23 +21,20 @@
         "build": "turbo run build",
         "build:v2": "turbo run build:v2",
         "clean-deps": "rm -rf node_modules && rm -rf packages/*/node_modules",
-        "lint": "turbo run lint",
-        "lint:fix": "turbo run lint -- --fix",
         "typecheck": "turbo run typecheck",
-        "format": "prettier ./ --ignore-unknown --write",
+        "format": "biome check --write ./",
-        "format:check": "prettier ./ --ignore-unknown --list-different",
+        "format:check": "biome check --diagnostic-level=error ./",
         "unit": "turbo run unit",
         "e2e": "turbo run e2e",
         "e2e-customers": "turbo run e2e-customers",
         "changeset": "changeset",
+        "changeset-version": "changeset version && bun run format",
         "release": "turbo run release && changeset publish",
         "release:preview": "turbo run release:preview",
         "download:env": "op read op://gitbook-x-dev/gitbook-open/.env.local >> .env.local",
         "clean": "turbo run clean"
     },
-    "workspaces": [
+    "workspaces": ["packages/*"],
-        "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/package.json

@@ -21,7 +21,7 @@
     },
     "devDependencies": {
         "typescript": "^5.5.3",
-        "wrangler": "^3.109.2"
+        "wrangler": "^3.112.0"
     },
     "scripts": {
         "generate": "wrangler types --experimental-include-runtime",
@@ -31,12 +31,5 @@
         "release": "wrangler deploy",
         "release:preview": "wrangler deploy && wrangler deploy --env preview"
     },
-    "files": [
+    "files": ["dist", "src", "bin", "data", "README.md", "CHANGELOG.md"]
-        "dist",
-        "src",
-        "bin",
-        "data",
-        "README.md",
-        "CHANGELOG.md"
-    ]
 }

packages/cache-do/src/CacheObject.ts

@@ -1,5 +1,5 @@
-import { encode, decode } from '@msgpack/msgpack';
 import { DurableObject } from 'cloudflare:workers';
+import { decode, encode } from '@msgpack/msgpack';
 import { LRUMap } from 'lru_map';
 
 export interface CacheObjectDescriptor {
@@ -137,7 +137,7 @@ export class CacheObject extends DurableObject {
      */
     public async purge() {
         return this.logOperation({ operation: 'purge' }, async (setLog) => {
-            let result = new Set<string>();
+            const result = new Set<string>();
 
             try {
                 // List all the keys in the cache object.
@@ -149,11 +149,7 @@ export class CacheObject extends DurableObject {
                 entries.forEach((exp) => {
                     result.add(exp.k);
                 });
-            } catch (error) {
+            } catch (_error) {}
-                // If an error occurs, reset the cache object.
-                // This is a safety mechanism to prevent the cache object from being stuck in a bad state.
-                console.error('Error during purge, resetting the cache object', error);
-            }
 
             await this.reset();
             return Array.from(result);
@@ -174,7 +170,7 @@ export class CacheObject extends DurableObject {
                 const toDeleteSet = new Set<string>();
 
                 for (const [key, exp] of entries) {
-                    const timestamp = parseInt(key.split('.')[1]);
+                    const timestamp = Number.parseInt(key.split('.')[1]);
                     if (timestamp < Date.now()) {
                         toDeleteSet.add(key);
                         for (let i = 0; i < exp.c; i++) {
@@ -194,10 +190,7 @@ export class CacheObject extends DurableObject {
                 if (toDelete.length) {
                     await this.ctx.storage.setAlarm(Date.now() + 12 * 60 * 60 * 1000);
                 }
-            } catch (error) {
+            } catch (_error) {
-                // If an error occurs, reset the cache object.
-                // This is a safety mechanism to prevent the cache object from being stuck in a bad state.
-                console.error('Error during alarm, reset the cache object', error);
                 await this.reset();
             }
         });
@@ -218,10 +211,10 @@ export class CacheObject extends DurableObject {
      */
     async logOperation<T>(
         log: Record<string, unknown>,
-        fn: (update: (log: Record<string, unknown>) => void) => Promise<T>,
+        fn: (update: (log: Record<string, unknown>) => void) => Promise<T>
     ): Promise<T> {
         const objectId = this.ctx.id.name ?? this.ctx.id.toString();
-        let update: Record<string, unknown> = {};
+        const update: Record<string, unknown> = {};
         const start = performance.now();
         try {
             return await fn((arg) => {
@@ -265,7 +258,7 @@ function encodeChunks<T>(key: string, value: T): Record<string, Uint8Array> {
 function decodeChunks<T>(entries: Map<string, Uint8Array>): { value: T; size: number } | undefined {
     const chunks = Array.from(entries.entries())
         .map(([key, value]) => {
-            const index = parseInt(key.split('.').pop()!);
+            const index = Number.parseInt(key.split('.').pop()!);
             return [index, value] as const;
         })
         .sort(([a], [b]) => a - b)

packages/cache-do/src/CacheObjectStub.ts

@@ -1,4 +1,4 @@
-import type { CacheObject, CacheObjectDescriptor } from './CacheObject';
+import type { CacheObject } from './CacheObject';
 
 export type CacheLocationId = ContinentCode;
 const allLocations: CacheLocationId[] = ['AF', 'AS', 'NA', 'SA', 'AN', 'EU', 'OC'];
@@ -30,7 +30,7 @@ export class CacheObjectStub {
         /** ID of the location to target */
         private locationId: CacheLocationId,
         /** Name of the tag */
-        private tag: string,
+        private tag: string
     ) {
         const groupId = getCacheObjectIdName(this.locationId, this.tag);
         this.stub = this.doNamespace.get(this.doNamespace.idFromName(groupId), {
@@ -85,7 +85,7 @@ export class CacheObjectStub {
                 });
                 const locationkeys = await cacheGroup.purge();
                 locationkeys.forEach((key) => keys.add(key));
-            }),
+            })
         );
 
         return keys;

packages/cache-tags/.gitignore

@@ -0,0 +1 @@
+dist/

packages/cache-tags/CHANGELOG.md

@@ -0,0 +1,13 @@
+# @gitbook/cache-tags
+
+## 0.2.0
+
+### Minor Changes
+
+- f32bf1f: Export function `getCacheTagForURL` to easily get the cache tag for a URL.
+
+## 0.1.0
+
+### Minor Changes
+
+- 05ffd0e: Initial version of the package

packages/cache-tags/README.md

@@ -0,0 +1,3 @@
+# `@gitbook/cache-tags`
+
+Utility to generate cache tags for GitBook Open.

packages/cache-tags/package.json

@@ -0,0 +1,25 @@
+{
+    "name": "@gitbook/cache-tags",
+    "type": "module",
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "development": "./src/index.ts",
+            "default": "./dist/index.js"
+        }
+    },
+    "version": "0.2.0",
+    "dependencies": {
+        "@gitbook/api": "*",
+        "assert-never": "^1.2.1"
+    },
+    "devDependencies": {
+        "typescript": "^5.5.3"
+    },
+    "scripts": {
+        "build": "tsc",
+        "typecheck": "tsc --noEmit",
+        "dev": "tsc -w"
+    },
+    "files": ["dist", "src", "README.md", "CHANGELOG.md"]
+}

packages/cache-tags/src/index.ts

@@ -0,0 +1,186 @@
+import type { ComputedContentSource } from '@gitbook/api';
+import assertNever from 'assert-never';
+
+/**
+ * Get a stringified cache tag for a given object.
+ */
+export function getCacheTag(
+    spec: /**
+     * All data related to a user
+     * @deprecated - in v2, no tag as this is an immutable data
+     */
+        | {
+              tag: 'user';
+              user: string;
+          }
+        /**
+         * All data related to a space
+         */
+        | {
+              tag: 'space';
+              space: string;
+          }
+        /**
+         * All data related to an integration.
+         */
+        | {
+              tag: 'integration';
+              integration: string;
+          }
+        /**
+         * All data related to a change request
+         */
+        | {
+              tag: 'change-request';
+              space: string;
+              changeRequest: string;
+          }
+        /**
+         * Immutable data related to a revision
+         * @deprecated - in v2, no tag as this is an immutable data
+         */
+        | {
+              tag: 'revision';
+              space: string;
+              revision: string;
+          }
+        /**
+         * Immutable data related to a document
+         * @deprecated - in v2, no tag as this is an immutable data
+         */
+        | {
+              tag: 'document';
+              space: string;
+              document: string;
+          }
+        /**
+         * Immutable data related to a computed document
+         * @deprecated - in v2, no tag as this is an immutable data
+         */
+        | {
+              tag: 'computed-document';
+              space: string;
+              integration: string;
+          }
+        /**
+         * All data related to the URL of a content
+         */
+        | {
+              tag: 'url';
+              hostname: string;
+          }
+        /**
+         * All data related to a site
+         */
+        | {
+              tag: 'site';
+              site: string;
+          }
+        /**
+         * All data related to an OpenAPI spec
+         */
+        | {
+              tag: 'openapi';
+              organization: string;
+              openAPISpec: string;
+          }
+): string {
+    switch (spec.tag) {
+        case 'user':
+            return `user:${spec.user}`;
+        case 'url':
+            return `url:${spec.hostname}`;
+        case 'space':
+            return `space:${spec.space}`;
+        case 'change-request':
+            return `space:${spec.space}:change-request:${spec.changeRequest}`;
+        case 'revision':
+            return `space:${spec.space}:revision:${spec.revision}`;
+        case 'document':
+            return `space:${spec.space}:document:${spec.document}`;
+        case 'computed-document':
+            return `space:${spec.space}:computed-document:${spec.integration}`;
+        case 'site':
+            return `site:${spec.site}`;
+        case 'integration':
+            return `integration:${spec.integration}`;
+        case 'openapi':
+            return `organization:${spec.organization}:openapi:${spec.openAPISpec}`;
+        default:
+            assertNever(spec);
+    }
+}
+
+/**
+ * Get the cache tag for a given URL.
+ */
+export function getCacheTagForURL(url: string | URL) {
+    const parsedURL = url instanceof URL ? url : new URL(url);
+    return getCacheTag({
+        tag: 'url',
+        hostname: parsedURL.hostname,
+    });
+}
+
+/**
+ * Get the tags for a computed content source.
+ */
+export function getComputedContentSourceCacheTags(
+    inContext: {
+        spaceId: string;
+        organizationId: string;
+    },
+    source: ComputedContentSource
+) {
+    const tags: string[] = [];
+
+    // We add the dependencies as tags, to ensure that the computed content is invalidated
+    // when the dependencies are updated.
+    const dependencies = Object.values(source.dependencies ?? {});
+    if (dependencies.length > 0) {
+        dependencies.forEach((dependency) => {
+            switch (dependency.ref.kind) {
+                case 'space':
+                    tags.push(
+                        getCacheTag({
+                            tag: 'space',
+                            space: dependency.ref.space,
+                        })
+                    );
+                    break;
+                case 'openapi':
+                    tags.push(
+                        getCacheTag({
+                            tag: 'openapi',
+                            organization: inContext.organizationId,
+                            openAPISpec: dependency.ref.spec,
+                        })
+                    );
+                    break;
+                default:
+                    // Do not throw for unknown dependency types
+                    // as it might mean we are lacking behind the API version
+                    break;
+            }
+        });
+    } else {
+        // Push a dummy tag, as the v1 is only using the first tag
+        tags.push(
+            getCacheTag({
+                tag: 'computed-document',
+                space: inContext.spaceId,
+                integration: source.integration,
+            })
+        );
+    }
+
+    // We invalidate the computed content when a new version of the integration is deployed.
+    tags.push(
+        getCacheTag({
+            tag: 'integration',
+            integration: source.integration,
+        })
+    );
+
+    return tags;
+}

packages/cache-tags/tsconfig.json

@@ -0,0 +1,24 @@
+{
+    "compilerOptions": {
+        "target": "esnext",
+        "lib": ["dom", "dom.iterable", "esnext"],
+        "allowJs": true,
+        "skipLibCheck": true,
+        "strict": true,
+        "noEmit": false,
+        "declaration": true,
+        "outDir": "dist",
+        "esModuleInterop": true,
+        "module": "esnext",
+        "moduleResolution": "bundler",
+        "resolveJsonModule": true,
+        "isolatedModules": true,
+        "jsx": "react-jsx",
+        "incremental": true,
+        "types": [
+            "bun-types" // add Bun global
+        ]
+    },
+    "include": ["src/**/*.ts", "src/**/*.tsx"],
+    "exclude": ["node_modules"]
+}

packages/colors/CHANGELOG.md

@@ -1,7 +1,13 @@
 # @gitbook/colors
 
+## 0.3.0
+
+### Minor Changes
+
+- 4f0a772: Override tint lightness if supplied color is out of bounds
+
 ## 0.2.0
 
 ### Minor Changes
 
--   445baaa: Initial release
+- 445baaa: Initial release

packages/colors/package.json

@@ -8,7 +8,7 @@
             "default": "./dist/index.js"
         }
     },
-    "version": "0.2.0",
+    "version": "0.3.0",
     "devDependencies": {
         "typescript": "^5.5.3"
     },
@@ -17,10 +17,5 @@
         "typecheck": "tsc --noEmit",
         "dev": "tsc -w"
     },
-    "files": [
+    "files": ["dist", "src", "README.md", "CHANGELOG.md"]
-        "dist",
-        "src",
-        "README.md",
-        "CHANGELOG.md"
-    ]
 }

packages/colors/src/transformations.ts

@@ -1,4 +1,4 @@
-import { DARK_BASE, LIGHT_BASE, DEFAULT_TINT_COLOR } from './colors';
+import { DARK_BASE, DEFAULT_TINT_COLOR, LIGHT_BASE } from './colors';
 
 type ColorShades = {
     [key: string]: string;
@@ -178,12 +178,13 @@ export function colorScale(
         background = darkMode ? DARK_BASE : LIGHT_BASE,
         foreground = darkMode ? LIGHT_BASE : DARK_BASE,
         mix,
-    }: ColorScaleOptions = {},
+    }: ColorScaleOptions = {}
 ) {
     const baseColor = rgbToOklch(hexToRgbArray(hex));
     const mixColor = mix?.color ? rgbToOklch(hexToRgbArray(mix.color)) : null;
     const foregroundColor = rgbToOklch(hexToRgbArray(foreground));
     const backgroundColor = rgbToOklch(hexToRgbArray(background));
+    let mapping = darkMode ? colorMixMapping.dark : colorMixMapping.light;
 
     if (mixColor && mix?.ratio && mix.ratio > 0) {
         // If defined, we mix in a (tiny) bit of the mix color with the base color.
@@ -192,7 +193,20 @@ export function colorScale(
         baseColor.H = mix.color === DEFAULT_TINT_COLOR ? baseColor.H : mixColor.H;
     }
 
-    const mapping = darkMode ? colorMixMapping.dark : colorMixMapping.light;
+    if (
+        (darkMode && baseColor.L < backgroundColor.L) ||
+        (!darkMode && baseColor.L > backgroundColor.L)
+    ) {
+        // If the supplied color is outside of our lightness bounds, use the supplied color's lightness.
+        // This is mostly used to allow darker-than-dark backgrounds for brands that specifically want that look.
+        const difference = (backgroundColor.L - baseColor.L) / backgroundColor.L;
+        backgroundColor.L = baseColor.L;
+        // At the edges of the scale, the subtle lightness changes stop being perceptible. We need to amp up our mapping to still stand out.
+        const amplifier = 1;
+        mapping = mapping.map((step, index) =>
+            index < 9 ? step + step * amplifier * difference : step
+        );
+    }
 
     const result = [];
 

packages/colors/tsconfig.json

@@ -13,7 +13,7 @@
         "moduleResolution": "bundler",
         "resolveJsonModule": true,
         "isolatedModules": true,
-        "jsx": "react",
+        "jsx": "react-jsx",
         "incremental": true,
         "types": [
             "bun-types" // add Bun global

packages/emoji-codepoints/build.ts

@@ -17,12 +17,11 @@ Object.entries(emojis).forEach(([key, value]) => {
     if (emoji && key !== emoji) {
         output[key] = emoji;
     } else if (!emoji) {
-        console.log('No emoji for', key);
     }
 });
 
 fs.mkdirSync(path.resolve(__dirname, 'dist'), { recursive: true });
 fs.writeFileSync(
     path.resolve(__dirname, 'dist/index.ts'),
-    `export const emojiCodepoints: Record<string, string> = ${JSON.stringify(output, null, 4)};`,
+    `export const emojiCodepoints: Record<string, string> = ${JSON.stringify(output, null, 4)};`
 );

packages/gitbook-v2/CHANGELOG.md

@@ -1,7 +1,41 @@
 # gitbook-v2
 
+## 0.2.2
+
+### Patch Changes
+
+- 54ee014: Add initial support for loading custom fonts
+- bba2e52: Fix site redirects when it includes a section/variant path
+
+## 0.2.1
+
+### Patch Changes
+
+- Updated dependencies [f32bf1f]
+  - @gitbook/cache-tags@0.2.0
+
+## 0.2.0
+
+### Minor Changes
+
+- 76c7974: Add route to revalidate cached data
+
+## 0.1.2
+
+### Patch Changes
+
+- 05ffd0e: Improving data cache management for computed content
+- Updated dependencies [05ffd0e]
+  - @gitbook/cache-tags@0.1.0
+
+## 0.1.1
+
+### Patch Changes
+
+- 3e11678: fix: lost section groups
+
 ## 0.1.0
 
 ### Minor Changes
 
--   cfccc44: Setup structure and deployment for new version
+- cfccc44: Setup structure and deployment for new version

packages/gitbook-v2/next.config.mjs

@@ -5,16 +5,41 @@
  */
 const nextConfig = {
     experimental: {
+        // This is needed to throw "forbidden" when the api token expired during revalidation
+        authInterrupts: true,
+
+        // This is needed to use 'use cache'
         useCache: true,
+
+        // Content is fully static, we can cache it in the session memory cache for a long time
+        staleTimes: {
+            dynamic: 3600, // 1 hour
+            static: 3600, // 1 hour
+        },
     },
 
     env: {
         BUILD_VERSION: (process.env.GITHUB_SHA ?? '').slice(0, 7),
-        GITBOOK_URL: process.env.GITBOOK_URL,
+
-        GITBOOK_ASSETS_PREFIX: process.env.GITBOOK_ASSETS_PREFIX,
+        // GitBook envs
+        GITBOOK_API_URL: process.env.GITBOOK_API_URL,
+        GITBOOK_APP_URL: process.env.GITBOOK_APP_URL,
+        GITBOOK_INTEGRATIONS_HOST: process.env.GITBOOK_INTEGRATIONS_HOST,
+        GITBOOK_IMAGE_RESIZE_URL: process.env.GITBOOK_IMAGE_RESIZE_URL,
         GITBOOK_ICONS_URL: process.env.GITBOOK_ICONS_URL,
         GITBOOK_ICONS_TOKEN: process.env.GITBOOK_ICONS_TOKEN,
+        GITBOOK_URL: process.env.GITBOOK_URL,
+        GITBOOK_API_TOKEN: process.env.GITBOOK_API_TOKEN,
+        GITBOOK_ASSETS_PREFIX: process.env.GITBOOK_ASSETS_PREFIX,
+        GITBOOK_SECRET: process.env.GITBOOK_SECRET,
+        GITBOOK_IMAGE_RESIZE_SIGNING_KEY: process.env.GITBOOK_IMAGE_RESIZE_SIGNING_KEY,
+        GITBOOK_FONTS_URL: process.env.GITBOOK_FONTS_URL,
+
+        // Next.js envs
         NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: process.env.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY,
+
+        // Used to detect if the app is running in V2 mode
+        GITBOOK_V2: 'true',
     },
 
     assetPrefix: process.env.GITBOOK_ASSETS_PREFIX,

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

@@ -1,30 +1,10 @@
-// default open-next.config.ts file created by @opennextjs/cloudflare
+import { defineCloudflareConfig } from '@opennextjs/cloudflare';
+import d1TagCache from '@opennextjs/cloudflare/d1-tag-cache';
+import kvIncrementalCache from '@opennextjs/cloudflare/kv-cache';
+import memoryQueue from '@opennextjs/cloudflare/memory-queue';
 
-import cache from '@opennextjs/cloudflare/kvCache';
+export default defineCloudflareConfig({
-
+    incrementalCache: kvIncrementalCache,
-const config = {
+    queue: memoryQueue,
-    default: {
+    tagCache: d1TagCache,
-        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,29 +1,35 @@
 {
     "name": "gitbook-v2",
-    "version": "0.1.0",
+    "version": "0.2.2",
     "private": true,
     "dependencies": {
-        "next": "canary",
+        "next": "^15.2.3",
         "react": "^19.0.0",
         "react-dom": "^19.0.0",
-        "@gitbook/api": "^0.96.0",
+        "@gitbook/api": "*",
+        "@gitbook/cache-tags": "workspace:*",
         "@sindresorhus/fnv1a": "^3.1.0",
-        "server-only": "^0.0.1"
+        "server-only": "^0.0.1",
+        "warn-once": "^0.1.1",
+        "rison": "^0.1.1",
+        "jwt-decode": "^4.0.0"
     },
     "devDependencies": {
         "gitbook": "*",
-        "@opennextjs/cloudflare": "^0.5.3",
+        "@opennextjs/cloudflare": "^0.5.10",
+        "@types/rison": "^0.0.9",
         "tailwindcss": "^3.4.0",
         "postcss": "^8"
     },
     "scripts": {
         "generate": "rm -rf ./public && cp -r ../gitbook/public ./public",
-        "dev:v2": "env-cmd --silent -f ../../.env.local next",
+        "dev:v2": "env-cmd --silent -f ../../.env.local next --turbopack",
         "build": "next build",
         "build:v2": "next build",
         "start": "next start",
         "build:v2:cloudflare": "opennextjs-cloudflare",
         "dev:v2:cloudflare": "wrangler dev --port 8771",
-        "unit": "bun test"
+        "unit": "bun test",
+        "typecheck": "tsc --noEmit"
     }
 }

packages/gitbook-v2/src/app/sites/dynamic/[mode]/[siteURL]/[siteData]/(content)/[pagePath]/page.tsx

@@ -1,10 +1,10 @@
-import { getDynamicSiteContext, getPagePathFromParams, RouteParams } from '@v2/app/utils';
 import {
+    SitePage,
     generateSitePageMetadata,
     generateSitePageViewport,
-    SitePage,
 } from '@/components/SitePage';
-import { Metadata, Viewport } from 'next';
+import { type RouteParams, getDynamicSiteContext, getPagePathFromParams } from '@v2/app/utils';
+import type { Metadata, Viewport } from 'next';
 
 type PageProps = {
     params: Promise<RouteParams>;
@@ -13,26 +13,24 @@ type PageProps = {
 
 export default async function Page(props: PageProps) {
     const params = await props.params;
-    const context = await getDynamicSiteContext(params);
+    const { context } = await getDynamicSiteContext(params);
     const pathname = getPagePathFromParams(params);
 
-    return <SitePage context={context} pageParams={{ pathname }} redirectOnFallback={true} />;
+    return <SitePage context={context} pageParams={{ pathname }} />;
 }
 
 export async function generateViewport(props: PageProps): Promise<Viewport> {
-    const context = await getDynamicSiteContext(await props.params);
+    const { context } = await getDynamicSiteContext(await props.params);
     return generateSitePageViewport(context);
 }
 
 export async function generateMetadata(props: PageProps): Promise<Metadata> {
-    const [params, searchParams] = await Promise.all([props.params, props.searchParams]);
+    const params = await props.params;
-    const context = await getDynamicSiteContext(params);
+    const { context } = await getDynamicSiteContext(params);
     const pathname = getPagePathFromParams(params);
 
     return generateSitePageMetadata({
         context,
         pageParams: { pathname },
-        redirectOnFallback: true,
-        fallback: !!searchParams.fallback,
     });
 }

packages/gitbook-v2/src/app/sites/dynamic/[mode]/[siteURL]/[siteData]/(content)/layout.tsx

@@ -0,0 +1,44 @@
+import { CustomizationRootLayout } from '@/components/RootLayout';
+import {
+    SiteLayout,
+    generateSiteLayoutMetadata,
+    generateSiteLayoutViewport,
+} from '@/components/SiteLayout';
+import { type RouteLayoutParams, getDynamicSiteContext } from '@v2/app/utils';
+import { GITBOOK_DISABLE_TRACKING } from '@v2/lib/env';
+import { getThemeFromMiddleware } from '@v2/lib/middleware';
+
+interface SiteDynamicLayoutProps {
+    params: Promise<RouteLayoutParams>;
+}
+
+export default async function SiteDynamicLayout({
+    params,
+    children,
+}: React.PropsWithChildren<SiteDynamicLayoutProps>) {
+    const { context, visitorAuthClaims } = await getDynamicSiteContext(await params);
+    const forcedTheme = await getThemeFromMiddleware();
+
+    return (
+        <CustomizationRootLayout customization={context.customization}>
+            <SiteLayout
+                context={context}
+                forcedTheme={forcedTheme}
+                withTracking={!GITBOOK_DISABLE_TRACKING}
+                visitorAuthClaims={visitorAuthClaims}
+            >
+                {children}
+            </SiteLayout>
+        </CustomizationRootLayout>
+    );
+}
+
+export async function generateViewport({ params }: SiteDynamicLayoutProps) {
+    const { context } = await getDynamicSiteContext(await params);
+    return generateSiteLayoutViewport(context);
+}
+
+export async function generateMetadata({ params }: SiteDynamicLayoutProps) {
+    const { context } = await getDynamicSiteContext(await params);
+    return generateSiteLayoutMetadata(context);
+}

packages/gitbook-v2/src/app/sites/dynamic/[mode]/[siteURL]/[siteData]/llms.txt/route.ts

@@ -0,0 +1,12 @@
+import type { NextRequest } from 'next/server';
+
+import { serveLLMsTxt } from '@/routes/llms';
+import { type RouteLayoutParams, getDynamicSiteContext } from '@v2/app/utils';
+
+export async function GET(
+    _request: NextRequest,
+    { params }: { params: Promise<RouteLayoutParams> }
+) {
+    const { context } = await getDynamicSiteContext(await params);
+    return serveLLMsTxt(context);
+}

packages/gitbook-v2/src/app/sites/dynamic/[mode]/[siteURL]/[siteData]/robots.txt/route.ts

@@ -0,0 +1,12 @@
+import type { NextRequest } from 'next/server';
+
+import { serveRobotsTxt } from '@/routes/robots';
+import { type RouteLayoutParams, getDynamicSiteContext } from '@v2/app/utils';
+
+export async function GET(
+    _request: NextRequest,
+    { params }: { params: Promise<RouteLayoutParams> }
+) {
+    const { context } = await getDynamicSiteContext(await params);
+    return serveRobotsTxt(context);
+}

packages/gitbook-v2/src/app/sites/dynamic/[mode]/[siteURL]/[siteData]/sitemap-pages.xml/route.ts

@@ -0,0 +1,12 @@
+import type { NextRequest } from 'next/server';
+
+import { servePagesSitemap } from '@/routes/sitemap';
+import { type RouteLayoutParams, getDynamicSiteContext } from '@v2/app/utils';
+
+export async function GET(
+    _request: NextRequest,
+    { params }: { params: Promise<RouteLayoutParams> }
+) {
+    const { context } = await getDynamicSiteContext(await params);
+    return servePagesSitemap(context);
+}

packages/gitbook-v2/src/app/sites/dynamic/[mode]/[siteURL]/[siteData]/sitemap.xml/route.ts

@@ -0,0 +1,12 @@
+import type { NextRequest } from 'next/server';
+
+import { serveRootSitemap } from '@/routes/sitemap';
+import { type RouteLayoutParams, getDynamicSiteContext } from '@v2/app/utils';
+
+export async function GET(
+    _request: NextRequest,
+    { params }: { params: Promise<RouteLayoutParams> }
+) {
+    const { context } = await getDynamicSiteContext(await params);
+    return serveRootSitemap(context);
+}

packages/gitbook-v2/src/app/sites/dynamic/[mode]/[siteURL]/[siteData]/~gitbook/icon/route.ts

@@ -0,0 +1,12 @@
+import type { NextRequest } from 'next/server';
+
+import { serveIcon } from '@/routes/icon';
+import { type RouteLayoutParams, getDynamicSiteContext } from '@v2/app/utils';
+
+export async function GET(
+    request: NextRequest,
+    { params }: { params: Promise<RouteLayoutParams> }
+) {
+    const { context } = await getDynamicSiteContext(await params);
+    return serveIcon(context, request);
+}

packages/gitbook-v2/src/app/sites/dynamic/[mode]/[siteURL]/[siteData]/~gitbook/ogimage/[pageId]/route.ts

@@ -0,0 +1,13 @@
+import type { NextRequest } from 'next/server';
+
+import type { PageIdParams } from '@/components/SitePage';
+import { serveOGImage } from '@/routes/ogimage';
+import { type RouteLayoutParams, getDynamicSiteContext } from '@v2/app/utils';
+
+export async function GET(
+    _request: NextRequest,
+    { params }: { params: Promise<RouteLayoutParams & PageIdParams> }
+) {
+    const { context } = await getDynamicSiteContext(await params);
+    return serveOGImage(context, await params);
+}

packages/gitbook-v2/src/app/sites/dynamic/[mode]/[siteURL]/[siteData]/~gitbook/pdf/layout.tsx

@@ -0,0 +1,12 @@
+import { PDFRootLayout } from '@/components/PDF';
+import { type RouteLayoutParams, getDynamicSiteContext } from '@v2/app/utils';
+
+export default async function RootLayout(props: {
+    params: Promise<RouteLayoutParams>;
+    children: React.ReactNode;
+}) {
+    const { params, children } = props;
+    const { context } = await getDynamicSiteContext(await params);
+
+    return <PDFRootLayout context={context}>{children}</PDFRootLayout>;
+}

packages/gitbook-v2/src/app/sites/dynamic/[mode]/[siteURL]/[siteData]/~gitbook/pdf/page.tsx

@@ -0,0 +1,20 @@
+import { PDFPage, generatePDFMetadata } from '@/components/PDF';
+import { type RouteLayoutParams, getDynamicSiteContext } from '@v2/app/utils';
+
+export async function generateMetadata({
+    params,
+}: {
+    params: Promise<RouteLayoutParams>;
+}) {
+    const { context } = await getDynamicSiteContext(await params);
+    return generatePDFMetadata(context);
+}
+
+export default async function Page(props: {
+    params: Promise<RouteLayoutParams>;
+    searchParams: Promise<{ [key: string]: string }>;
+}) {
+    const { params, searchParams } = props;
+    const { context } = await getDynamicSiteContext(await params);
+    return <PDFPage context={context} searchParams={await searchParams} />;
+}

packages/gitbook-v2/src/app/sites/dynamic/[mode]/[siteURL]/layout.tsx

@@ -1,28 +0,0 @@
-import { CustomizationRootLayout } from '@/components/RootLayout';
-import { SiteLayout } from '@/components/SiteLayout';
-import { getDynamicSiteContext, RouteLayoutParams } from '@v2/app/utils';
-import { GITBOOK_DISABLE_TRACKING } from '@v2/lib/env';
-import { getThemeFromMiddleware } from '@v2/lib/middleware';
-
-export default async function SiteDynamicLayout({
-    params,
-    children,
-}: {
-    params: Promise<RouteLayoutParams>;
-    children: React.ReactNode;
-}) {
-    const context = await getDynamicSiteContext(await params);
-    const forcedTheme = await getThemeFromMiddleware();
-
-    return (
-        <CustomizationRootLayout customization={context.customization}>
-            <SiteLayout
-                context={context}
-                forcedTheme={forcedTheme}
-                withTracking={!GITBOOK_DISABLE_TRACKING}
-            >
-                {children}
-            </SiteLayout>
-        </CustomizationRootLayout>
-    );
-}

packages/gitbook-v2/src/app/sites/static/[mode]/[siteURL]/[pagePath]/loading.tsx

@@ -1,5 +0,0 @@
-import { SitePageSkeleton } from '@/components/SitePage';
-
-export default function Loading() {
-    return <SitePageSkeleton />;
-}

packages/gitbook-v2/src/app/sites/static/[mode]/[siteURL]/[siteData]/[pagePath]/page.tsx

@@ -1,12 +1,12 @@
-import { unstable_cacheTag as cacheTag } from 'next/cache';
-import { getSiteCacheTag } from '@v2/lib/cache';
-import { getPagePathFromParams, getStaticSiteContext, RouteParams } from '@v2/app/utils';
 import {
+    SitePage,
     generateSitePageMetadata,
     generateSitePageViewport,
-    SitePage,
 } from '@/components/SitePage';
-import { Metadata, Viewport } from 'next';
+import { getCacheTag } from '@gitbook/cache-tags';
+import { type RouteParams, getPagePathFromParams, getStaticSiteContext } from '@v2/app/utils';
+import type { Metadata, Viewport } from 'next';
+import { unstable_cacheTag as cacheTag } from 'next/cache';
 
 export const dynamic = 'force-static';
 
@@ -18,27 +18,31 @@ export default async function Page(props: PageProps) {
     'use cache';
 
     const params = await props.params;
-    const context = await getStaticSiteContext(params);
+    const { context } = await getStaticSiteContext(params);
     const pathname = getPagePathFromParams(params);
 
-    cacheTag(getSiteCacheTag(context.site.id));
+    cacheTag(
+        getCacheTag({
+            tag: 'site',
+            site: context.site.id,
+        })
+    );
 
-    return <SitePage context={context} pageParams={{ pathname }} redirectOnFallback={true} />;
+    return <SitePage context={context} pageParams={{ pathname }} />;
 }
 
 export async function generateViewport(props: PageProps): Promise<Viewport> {
-    const context = await getStaticSiteContext(await props.params);
+    const { context } = await getStaticSiteContext(await props.params);
     return generateSitePageViewport(context);
 }
 
 export async function generateMetadata(props: PageProps): Promise<Metadata> {
     const params = await props.params;
-    const context = await getStaticSiteContext(params);
+    const { context } = await getStaticSiteContext(params);
     const pathname = getPagePathFromParams(params);
 
     return generateSitePageMetadata({
         context,
         pageParams: { pathname },
-        redirectOnFallback: true,
     });
 }

packages/gitbook-v2/src/app/sites/static/[mode]/[siteURL]/[siteData]/layout.tsx

@@ -0,0 +1,52 @@
+import { CustomizationRootLayout } from '@/components/RootLayout';
+import {
+    SiteLayout,
+    generateSiteLayoutMetadata,
+    generateSiteLayoutViewport,
+} from '@/components/SiteLayout';
+import { getCacheTag } from '@gitbook/cache-tags';
+import { type RouteLayoutParams, getStaticSiteContext } from '@v2/app/utils';
+import { GITBOOK_DISABLE_TRACKING } from '@v2/lib/env';
+import { unstable_cacheTag as cacheTag } from 'next/cache';
+
+interface SiteStaticLayoutProps {
+    params: Promise<RouteLayoutParams>;
+}
+
+export default async function SiteStaticLayout({
+    params,
+    children,
+}: React.PropsWithChildren<SiteStaticLayoutProps>) {
+    'use cache';
+
+    const { context, visitorAuthClaims } = await getStaticSiteContext(await params);
+
+    cacheTag(
+        getCacheTag({
+            tag: 'site',
+            site: context.site.id,
+        })
+    );
+
+    return (
+        <CustomizationRootLayout customization={context.customization}>
+            <SiteLayout
+                context={context}
+                withTracking={!GITBOOK_DISABLE_TRACKING}
+                visitorAuthClaims={visitorAuthClaims}
+            >
+                {children}
+            </SiteLayout>
+        </CustomizationRootLayout>
+    );
+}
+
+export async function generateViewport({ params }: SiteStaticLayoutProps) {
+    const { context } = await getStaticSiteContext(await params);
+    return generateSiteLayoutViewport(context);
+}
+
+export async function generateMetadata({ params }: SiteStaticLayoutProps) {
+    const { context } = await getStaticSiteContext(await params);
+    return generateSiteLayoutMetadata(context);
+}

packages/gitbook-v2/src/app/sites/static/[mode]/[siteURL]/[siteData]/llms.txt/route.ts

@@ -0,0 +1,14 @@
+import type { NextRequest } from 'next/server';
+
+import { serveLLMsTxt } from '@/routes/llms';
+import { type RouteLayoutParams, getStaticSiteContext } from '@v2/app/utils';
+
+export const dynamic = 'force-static';
+
+export async function GET(
+    _request: NextRequest,
+    { params }: { params: Promise<RouteLayoutParams> }
+) {
+    const { context } = await getStaticSiteContext(await params);
+    return serveLLMsTxt(context);
+}

packages/gitbook-v2/src/app/sites/static/[mode]/[siteURL]/[siteData]/robots.txt/route.ts

@@ -0,0 +1,14 @@
+import type { NextRequest } from 'next/server';
+
+import { serveRobotsTxt } from '@/routes/robots';
+import { type RouteLayoutParams, getStaticSiteContext } from '@v2/app/utils';
+
+export const dynamic = 'force-static';
+
+export async function GET(
+    _request: NextRequest,
+    { params }: { params: Promise<RouteLayoutParams> }
+) {
+    const { context } = await getStaticSiteContext(await params);
+    return serveRobotsTxt(context);
+}

packages/gitbook-v2/src/app/sites/static/[mode]/[siteURL]/[siteData]/sitemap-pages.xml/route.ts

@@ -0,0 +1,14 @@
+import type { NextRequest } from 'next/server';
+
+import { servePagesSitemap } from '@/routes/sitemap';
+import { type RouteLayoutParams, getStaticSiteContext } from '@v2/app/utils';
+
+export const dynamic = 'force-static';
+
+export async function GET(
+    _request: NextRequest,
+    { params }: { params: Promise<RouteLayoutParams> }
+) {
+    const { context } = await getStaticSiteContext(await params);
+    return servePagesSitemap(context);
+}

packages/gitbook-v2/src/app/sites/static/[mode]/[siteURL]/[siteData]/sitemap.xml/route.ts

@@ -0,0 +1,14 @@
+import type { NextRequest } from 'next/server';
+
+import { serveRootSitemap } from '@/routes/sitemap';
+import { type RouteLayoutParams, getStaticSiteContext } from '@v2/app/utils';
+
+export const dynamic = 'force-static';
+
+export async function GET(
+    _request: NextRequest,
+    { params }: { params: Promise<RouteLayoutParams> }
+) {
+    const { context } = await getStaticSiteContext(await params);
+    return serveRootSitemap(context);
+}

packages/gitbook-v2/src/app/sites/static/[mode]/[siteURL]/[siteData]/~gitbook/icon/route.ts

@@ -0,0 +1,14 @@
+import type { NextRequest } from 'next/server';
+
+import { serveIcon } from '@/routes/icon';
+import { type RouteLayoutParams, getStaticSiteContext } from '@v2/app/utils';
+
+export const dynamic = 'force-static';
+
+export async function GET(
+    request: NextRequest,
+    { params }: { params: Promise<RouteLayoutParams> }
+) {
+    const { context } = await getStaticSiteContext(await params);
+    return serveIcon(context, request);
+}

packages/gitbook-v2/src/app/sites/static/[mode]/[siteURL]/[siteData]/~gitbook/ogimage/[pageId]/route.ts

@@ -0,0 +1,15 @@
+import type { NextRequest } from 'next/server';
+
+import type { PageIdParams } from '@/components/SitePage';
+import { serveOGImage } from '@/routes/ogimage';
+import { type RouteLayoutParams, getStaticSiteContext } from '@v2/app/utils';
+
+export const dynamic = 'force-static';
+
+export async function GET(
+    _request: NextRequest,
+    { params }: { params: Promise<RouteLayoutParams & PageIdParams> }
+) {
+    const { context } = await getStaticSiteContext(await params);
+    return serveOGImage(context, await params);
+}

packages/gitbook-v2/src/app/sites/static/[mode]/[siteURL]/layout.tsx

@@ -1,28 +0,0 @@
-import { unstable_cacheTag as cacheTag } from 'next/cache';
-import { getSiteCacheTag } from '@v2/lib/cache';
-import { getStaticSiteContext, RouteLayoutParams } from '@v2/app/utils';
-import { CustomizationRootLayout } from '@/components/RootLayout';
-import { SiteLayout } from '@/components/SiteLayout';
-import { GITBOOK_DISABLE_TRACKING } from '@v2/lib/env';
-
-export default async function SiteStaticLayout({
-    params,
-    children,
-}: {
-    params: Promise<RouteLayoutParams>;
-    children: React.ReactNode;
-}) {
-    'use cache';
-
-    const context = await getStaticSiteContext(await params);
-
-    cacheTag(getSiteCacheTag(context.site.id));
-
-    return (
-        <CustomizationRootLayout customization={context.customization}>
-            <SiteLayout context={context} withTracking={!GITBOOK_DISABLE_TRACKING}>
-                {children}
-            </SiteLayout>
-        </CustomizationRootLayout>
-    );
-}

packages/gitbook-v2/src/app/utils.ts

@@ -1,9 +1,9 @@
-import { fetchSiteContextByURL } from '@v2/lib/context';
+import { getVisitorAuthClaims, getVisitorAuthClaimsFromToken } from '@/lib/adaptive';
-import { createDataFetcher } from '@v2/lib/data';
+import type { PublishedSiteContent, SiteAPIToken } from '@gitbook/api';
-import { GITBOOK_API_TOKEN, GITBOOK_API_URL, GITBOOK_URL } from '@v2/lib/env';
+import { fetchSiteContextByURLLookup, getBaseContext } from '@v2/lib/context';
-import { createNoopImageResizer } from '@v2/lib/images';
+import { jwtDecode } from 'jwt-decode';
-import { createLinker } from '@v2/lib/links';
+import { forbidden } from 'next/navigation';
-import { headers } from 'next/headers';
+import rison from 'rison';
 
 export type RouteParamMode = 'url-host' | 'url';
 
@@ -12,6 +12,9 @@ export type RouteLayoutParams = {
 
     /** URL encoded site URL */
     siteURL: string;
+
+    /** URL and Rison encoded site data from getPublishedContentByUrl */
+    siteData: string;
 };
 
 export type RouteParams = RouteLayoutParams & {
@@ -21,25 +24,30 @@ export type RouteParams = RouteLayoutParams & {
 /**
  * Get the static context when rendering statically a site.
  */
-export function getStaticSiteContext(params: RouteLayoutParams) {
+export async function getStaticSiteContext(params: RouteLayoutParams) {
-    const url = getSiteURLFromParams(params);
+    const siteURL = getSiteURLFromParams(params);
+    const siteURLData = getSiteURLDataFromParams(params);
 
-    const dataFetcher = createDataFetcher();
+    // For static routes, we check the expiration of the JWT token
-    const linker = createLinkerFromParams(params);
+    // as the route might be revalidated after expiration
-    const imageResizer = createNoopImageResizer();
+    const decoded = jwtDecode<SiteAPIToken & { exp: number }>(siteURLData.apiToken);
+    if (decoded.exp && decoded.exp < Date.now() / 1000 + 120) {
+        forbidden();
+    }
 
-    return fetchSiteContextByURL(
+    const context = await fetchSiteContextByURLLookup(
-        {
+        getBaseContext({
-            dataFetcher,
+            siteURL,
-            linker,
+            siteURLData,
-            imageResizer,
+            urlMode: getModeFromParams(params.mode),
-        },
+        }),
-        {
+        siteURLData
-            url: url.toString(),
-            visitorAuthToken: null,
-            redirectOnError: false,
-        },
     );
+
+    return {
+        context,
+        visitorAuthClaims: getVisitorAuthClaimsFromToken(decoded),
+    };
 }
 
 /**
@@ -47,31 +55,22 @@ export function getStaticSiteContext(params: RouteLayoutParams) {
  * The context will depend on the request.
  */
 export async function getDynamicSiteContext(params: RouteLayoutParams) {
-    const url = getSiteURLFromParams(params);
+    const siteURL = getSiteURLFromParams(params);
-    const headersSet = await headers();
+    const siteURLData = getSiteURLDataFromParams(params);
 
-    const dataFetcher = createDataFetcher({
+    const context = await fetchSiteContextByURLLookup(
-        apiToken: headersSet.get('x-gitbook-token') ?? GITBOOK_API_TOKEN,
+        getBaseContext({
-        apiEndpoint: headersSet.get('x-gitbook-api') ?? GITBOOK_API_URL,
+            siteURL,
-    });
+            siteURLData,
-
+            urlMode: getModeFromParams(params.mode),
-    const linker = createLinkerFromParams(params);
+        }),
-    const imageResizer = createNoopImageResizer();
+        siteURLData
-
-    return fetchSiteContextByURL(
-        {
-            dataFetcher,
-            linker,
-            imageResizer,
-        },
-        {
-            url: url.toString(),
-            visitorAuthToken: headersSet.get('x-gitbook-visitor-token'),
-
-            // TODO: set it only when the token comes from the cookies.
-            redirectOnError: true,
-        },
     );
+
+    return {
+        context,
+        visitorAuthClaims: getVisitorAuthClaims(siteURLData),
+    };
 }
 
 /**
@@ -82,28 +81,9 @@ export function getPagePathFromParams(params: RouteParams) {
     return decoded;
 }
 
-function createLinkerFromParams(params: RouteLayoutParams) {
-    const url = getSiteURLFromParams(params);
-    const mode = getModeFromParams(params.mode);
-
-    if (mode === 'url-host') {
-        return createLinker({
-            host: url.host,
-            pathname: '/',
-        });
-    }
-
-    const gitbookURL = new URL(GITBOOK_URL);
-    return createLinker({
-        protocol: gitbookURL.protocol,
-        host: gitbookURL.host,
-        pathname: `/url/${url.host}`,
-    });
-}
-
 function getSiteURLFromParams(params: RouteLayoutParams) {
     const decoded = decodeURIComponent(params.siteURL);
-    const url = new URL('https://' + decoded);
+    const url = new URL(`https://${decoded}`);
     return url;
 }
 
@@ -114,3 +94,11 @@ function getModeFromParams(mode: string): RouteParamMode {
 
     return 'url';
 }
+
+/**
+ * Get the decoded site data from the params.
+ */
+function getSiteURLDataFromParams(params: RouteLayoutParams): PublishedSiteContent {
+    const decoded = decodeURIComponent(params.siteData);
+    return rison.decode(decoded);
+}

packages/gitbook-v2/src/app/~gitbook/env/route.ts

@@ -0,0 +1,40 @@
+import { type NextRequest, NextResponse } from 'next/server';
+
+import {
+    GITBOOK_API_PUBLIC_URL,
+    GITBOOK_API_TOKEN,
+    GITBOOK_API_URL,
+    GITBOOK_APP_URL,
+    GITBOOK_ASSETS_URL,
+    GITBOOK_DISABLE_TRACKING,
+    GITBOOK_FONTS_URL,
+    GITBOOK_ICONS_URL,
+    GITBOOK_IMAGE_RESIZE_SIGNING_KEY,
+    GITBOOK_INTEGRATIONS_HOST,
+    GITBOOK_SECRET,
+    GITBOOK_URL,
+    GITBOOK_USER_AGENT,
+} from '@v2/lib/env';
+
+/**
+ * Output the public environment variables for this deployment
+ */
+export async function GET(_req: NextRequest) {
+    return NextResponse.json({
+        GITBOOK_URL,
+        GITBOOK_APP_URL,
+        GITBOOK_API_URL,
+        GITBOOK_API_PUBLIC_URL,
+        GITBOOK_ASSETS_URL,
+        GITBOOK_FONTS_URL,
+        GITBOOK_ICONS_URL,
+        GITBOOK_USER_AGENT,
+        GITBOOK_INTEGRATIONS_HOST,
+        GITBOOK_DISABLE_TRACKING,
+
+        // Secret envs
+        GITBOOK_SECRET: !!GITBOOK_SECRET,
+        GITBOOK_API_TOKEN: !!GITBOOK_API_TOKEN,
+        GITBOOK_IMAGE_RESIZE_SIGNING_KEY: !!GITBOOK_IMAGE_RESIZE_SIGNING_KEY,
+    });
+}

packages/gitbook-v2/src/app/~gitbook/revalidate/route.ts

@@ -0,0 +1,35 @@
+import { type NextRequest, NextResponse } from 'next/server';
+
+import { withVerifySignature } from '@v2/lib/routes';
+import { revalidateTag } from 'next/cache';
+
+interface JsonBody {
+    tags: string[];
+}
+
+/**
+ * Revalidate cached data based on tags.
+ * The body should be a JSON with { tags: string[] }
+ */
+export async function POST(req: NextRequest) {
+    return withVerifySignature<JsonBody>(req, async (body) => {
+        if (!body.tags || !Array.isArray(body.tags)) {
+            return NextResponse.json(
+                {
+                    error: 'tags must be an array',
+                },
+                { status: 400 }
+            );
+        }
+
+        body.tags.forEach((tag) => {
+            // biome-ignore lint/suspicious/noConsole: we want to log here
+            console.log(`Revalidating tag: ${tag}`);
+            revalidateTag(tag);
+        });
+
+        return NextResponse.json({
+            success: true,
+        });
+    });
+}

packages/gitbook-v2/src/app/~space/[spaceId]/pdf.ts

@@ -0,0 +1,59 @@
+import {
+    type GitBookBaseContext,
+    type GitBookSpaceContext,
+    fetchSpaceContextByIds,
+} from '@v2/lib/context';
+import { createDataFetcher } from '@v2/lib/data';
+import { createLinker } from '@v2/lib/links';
+import { getAPITokenFromMiddleware } from '@v2/lib/middleware';
+
+export type SpacePDFRouteParams = {
+    spaceId: string;
+    changeRequestId?: string;
+    revisionId?: string;
+};
+
+export async function getSpacePDFContext(
+    params: SpacePDFRouteParams
+): Promise<GitBookSpaceContext> {
+    const { spaceId } = params;
+
+    const apiToken = await getAPITokenFromMiddleware();
+
+    const basePath = getPDFRoutePath(params);
+    const linker = createLinker({
+        spaceBasePath: basePath,
+        siteBasePath: basePath,
+    });
+    const dataFetcher = createDataFetcher({
+        apiToken: apiToken,
+    });
+
+    const baseContext: GitBookBaseContext = {
+        linker,
+        dataFetcher,
+    };
+
+    return await fetchSpaceContextByIds(baseContext, {
+        space: spaceId,
+        shareKey: undefined,
+        changeRequest: params.changeRequestId,
+        revision: params.revisionId,
+    });
+}
+
+function getPDFRoutePath(params: SpacePDFRouteParams) {
+    let path = `/~space/${params.spaceId}`;
+
+    if (params.changeRequestId) {
+        path += `/~/changes/${params.changeRequestId}`;
+    }
+
+    if (params.revisionId) {
+        path += `/~/revisions/${params.revisionId}`;
+    }
+
+    path += '~gitbook/pdf';
+
+    return path;
+}

packages/gitbook-v2/src/app/~space/[spaceId]/~/changes/[changeRequestId]/~gitbook/pdf/layout.tsx

@@ -0,0 +1,2 @@
+import RootLayout from '@v2/app/~space/[spaceId]/~gitbook/pdf/layout';
+export default RootLayout;

packages/gitbook-v2/src/app/~space/[spaceId]/~/changes/[changeRequestId]/~gitbook/pdf/page.tsx

@@ -0,0 +1,4 @@
+import PDFPage, { generateMetadata } from '@v2/app/~space/[spaceId]/~gitbook/pdf/page';
+
+export default PDFPage;
+export { generateMetadata };

packages/gitbook-v2/src/app/~space/[spaceId]/~/revisions/[changeRequestId]/~gitbook/pdf/layout.tsx

@@ -0,0 +1,2 @@
+import RootLayout from '@v2/app/~space/[spaceId]/~gitbook/pdf/layout';
+export default RootLayout;

packages/gitbook-v2/src/app/~space/[spaceId]/~/revisions/[changeRequestId]/~gitbook/pdf/page.tsx

@@ -0,0 +1,4 @@
+import PDFPage, { generateMetadata } from '@v2/app/~space/[spaceId]/~gitbook/pdf/page';
+
+export default PDFPage;
+export { generateMetadata };

packages/gitbook-v2/src/app/~space/[spaceId]/~gitbook/pdf/layout.tsx

@@ -0,0 +1,12 @@
+import { PDFRootLayout } from '@/components/PDF';
+import { type SpacePDFRouteParams, getSpacePDFContext } from '@v2/app/~space/[spaceId]/pdf';
+
+export default async function RootLayout(props: {
+    params: Promise<SpacePDFRouteParams>;
+    children: React.ReactNode;
+}) {
+    const { params, children } = props;
+    const context = await getSpacePDFContext(await params);
+
+    return <PDFRootLayout context={context}>{children}</PDFRootLayout>;
+}

packages/gitbook-v2/src/app/~space/[spaceId]/~gitbook/pdf/page.tsx

@@ -0,0 +1,20 @@
+import { PDFPage, generatePDFMetadata } from '@/components/PDF';
+import { type SpacePDFRouteParams, getSpacePDFContext } from '@v2/app/~space/[spaceId]/pdf';
+
+export async function generateMetadata({
+    params,
+}: {
+    params: Promise<SpacePDFRouteParams>;
+}) {
+    const context = await getSpacePDFContext(await params);
+    return generatePDFMetadata(context);
+}
+
+export default async function Page(props: {
+    params: Promise<SpacePDFRouteParams>;
+    searchParams: Promise<{ [key: string]: string }>;
+}) {
+    const { params, searchParams } = props;
+    const context = await getSpacePDFContext(await params);
+    return <PDFPage context={context} searchParams={await searchParams} />;
+}

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

@@ -1,34 +0,0 @@
-/**
- * Get the cache tag for a site.
- */
-export function getSiteCacheTag(siteId: string) {
-    return `site:${siteId}`;
-}
-
-/**
- * Get the cache tag for a hostname.
- */
-export function getHostnameCacheTag(hostname: string) {
-    return `url:${hostname}`;
-}
-
-/**
- * Get the cache tag for an OpenAPI spec.
- */
-export function getOpenAPISpecCacheTag(organizationId: string, slug: string) {
-    return `organization:${organizationId}:openapi:${slug}`;
-}
-
-/**
- * Get the cache tag for a space.
- */
-export function getSpaceCacheTag(spaceId: string) {
-    return `space:${spaceId}`;
-}
-
-/**
- * Get the cache tag for a change request.
- */
-export function getChangeRequestCacheTag(spaceId: string, changeRequestId: string) {
-    return `space:${spaceId}:change-request:${changeRequestId}`;
-}

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

@@ -1,5 +1,7 @@
-import {
+import { getSiteStructureSections } from '@/lib/sites';
+import type {
     ChangeRequest,
+    PublishedSiteContent,
     RevisionPage,
     RevisionPageDocument,
     Site,
@@ -11,12 +13,11 @@ import {
     SiteStructure,
     Space,
 } from '@gitbook/api';
-import { redirect } from 'next/navigation';
+import { type GitBookDataFetcher, createDataFetcher, throwIfDataError } from '@v2/lib/data';
 import { assert } from 'ts-essentials';
-import { getSiteStructureSections } from '@/lib/sites';
+import { GITBOOK_URL } from './env';
-import { createDataFetcher, GitBookDataFetcher } from '@v2/lib/data';
+import { type ImageResizer, createImageResizer } from './images';
-import { GitBookSpaceLinker, appendPrefixToLinker } from './links';
+import { type GitBookLinker, createLinker } from './links';
-import { ImageResizer } from './images';
 
 /**
  * Generic context when rendering content.
@@ -30,12 +31,12 @@ export type GitBookBaseContext = {
     /**
      * Linker to generate links in the current space.
      */
-    linker: GitBookSpaceLinker;
+    linker: GitBookLinker;
 
     /**
      * Image resizer to resize images.
      */
-    imageResizer: ImageResizer;
+    imageResizer?: ImageResizer;
 };
 
 /**
@@ -90,9 +91,6 @@ export type GitBookSiteContext = GitBookSpaceContext & {
 
     /** Scripts to load for the site. */
     scripts: SiteIntegrationScript[];
-
-    /** Visitor token used to fetch the site */
-    visitorAuthToken: string | null;
 };
 
 /**
@@ -103,54 +101,74 @@ export type GitBookPageContext = (GitBookSpaceContext | GitBookSiteContext) & {
 };
 
 /**
- * Fetch the context of a site for a given URL and a base context.
+ * Get the base context for a request on a site.
  */
-export async function fetchSiteContextByURL(
+export function getBaseContext(input: {
-    baseContext: GitBookBaseContext,
+    siteURL: URL | string;
-    input: {
+    siteURLData: PublishedSiteContent;
-        url: string;
+    urlMode: 'url' | 'url-host';
-        visitorAuthToken: string | null;
+}) {
-        redirectOnError: boolean;
+    const { urlMode, siteURLData } = input;
-    },
+    const siteURL = typeof input.siteURL === 'string' ? new URL(input.siteURL) : input.siteURL;
-): Promise<GitBookSiteContext> {
+
-    const { dataFetcher } = baseContext;
+    const dataFetcher = createDataFetcher({
-    const data = await dataFetcher.getPublishedContentByUrl({
+        apiToken: siteURLData.apiToken ?? null,
-        url: input.url,
-        visitorAuthToken: input.visitorAuthToken,
-        redirectOnError: input.redirectOnError,
     });
 
-    if ('redirect' in data) {
+    const gitbookURL = GITBOOK_URL ? new URL(GITBOOK_URL) : undefined;
-        redirect(data.redirect);
+    const linker =
+        urlMode === 'url-host'
+            ? createLinker({
+                  host: siteURL.host,
+                  siteBasePath: siteURLData.siteBasePath,
+                  spaceBasePath: siteURLData.basePath,
+              })
+            : createLinker({
+                  protocol: gitbookURL?.protocol,
+                  host: gitbookURL?.host,
+                  siteBasePath: `/url/${siteURL.host}${siteURLData.siteBasePath}`,
+                  spaceBasePath: `/url/${siteURL.host}${siteURLData.basePath}`,
+              });
+
+    if (urlMode === 'url') {
+        // Create link in the same format for links to other sites/sections.
+        linker.toLinkForContent = (rawURL: string) => {
+            const urlObject = new URL(rawURL);
+            return `/url/${urlObject.host}${urlObject.pathname}${urlObject.search}`;
+        };
     }
 
-    const context = await fetchSiteContextByIds(
+    const imageResizer = createImageResizer({
-        {
+        host: siteURL.host,
-            ...baseContext,
+        // To ensure image resizing work for proxied sites,
-            dataFetcher: createDataFetcher({
+        // we serve images from the root of the site.
-                apiEndpoint: dataFetcher.apiEndpoint,
+        linker: linker,
-                apiToken: data.apiToken,
+    });
-            }),
-        },
-        {
-            organization: data.organization,
-            site: data.site,
-            siteSection: data.siteSection,
-            siteSpace: data.siteSpace,
-            space: data.space,
-            shareKey: data.shareKey,
-            changeRequest: data.changeRequest,
-            revision: data.revision,
-            visitorAuthToken: input.visitorAuthToken,
-        },
-    );
 
-    const siteContext = {
+    return {
-        ...context,
+        dataFetcher,
-        linker: appendPrefixToLinker(context.linker, data.basePath),
+        linker,
+        imageResizer,
     };
+}
 
-    return siteContext;
+/**
+ * Fetch the context of a site using the resolution of a URL
+ */
+export async function fetchSiteContextByURLLookup(
+    baseContext: GitBookBaseContext,
+    data: PublishedSiteContent
+): Promise<GitBookSiteContext> {
+    return await fetchSiteContextByIds(baseContext, {
+        organization: data.organization,
+        site: data.site,
+        siteSection: data.siteSection,
+        siteSpace: data.siteSpace,
+        space: data.space,
+        shareKey: data.shareKey,
+        changeRequest: data.changeRequest,
+        revision: data.revision,
+    });
 }
 
 /**
@@ -167,18 +185,19 @@ export async function fetchSiteContextByIds(
         shareKey: string | undefined;
         changeRequest: string | undefined;
         revision: string | undefined;
-        visitorAuthToken: string | null;
+    }
-    },
 ): Promise<GitBookSiteContext> {
     const { dataFetcher } = baseContext;
 
     const [{ site: orgSite, structure: siteStructure, customizations, scripts }, spaceContext] =
         await Promise.all([
-            dataFetcher.getPublishedContentSite({
+            throwIfDataError(
-                organizationId: ids.organization,
+                dataFetcher.getPublishedContentSite({
-                siteId: ids.site,
+                    organizationId: ids.organization,
-                siteShareKey: ids.shareKey,
+                    siteId: ids.site,
-            }),
+                    siteShareKey: ids.shareKey,
+                })
+            ),
             fetchSpaceContextByIds(baseContext, ids),
         ]);
 
@@ -189,7 +208,9 @@ export async function fetchSiteContextByIds(
         ...(customizations.site?.title ? { title: customizations.site.title } : {}),
     };
 
-    const sections = ids.siteSection ? parseSiteSectionsList(siteStructure, ids.siteSection) : null;
+    const sections = ids.siteSection
+        ? parseSiteSectionsAndGroups(siteStructure, ids.siteSection)
+        : null;
 
     const siteSpace = (
         siteStructure.type === 'siteSpaces' && siteStructure.structure
@@ -211,11 +232,13 @@ export async function fetchSiteContextByIds(
             if (siteSpaceSettings) {
                 return siteSpaceSettings;
             }
+
             // We got the pointer from an API and customizations from another.
             // It's possible that the two are unsynced leading to not found customizations for the space.
             // It's better to fallback on customization of the site that displaying an error.
             console.warn('Customization not found for site space', ids.siteSpace);
         }
+
         return customizations.site;
     })();
 
@@ -229,7 +252,6 @@ export async function fetchSiteContextByIds(
         structure: siteStructure,
         sections,
         scripts,
-        visitorAuthToken: ids.visitorAuthToken,
     };
 }
 
@@ -243,32 +265,38 @@ export async function fetchSpaceContextByIds(
         shareKey: string | undefined;
         changeRequest: string | undefined;
         revision: string | undefined;
-    },
+    }
 ): Promise<GitBookSpaceContext> {
     const { dataFetcher } = baseContext;
 
     const [space, changeRequest] = await Promise.all([
-        dataFetcher.getSpace({
+        throwIfDataError(
-            spaceId: ids.space,
+            dataFetcher.getSpace({
-            shareKey: ids.shareKey,
+                spaceId: ids.space,
-        }),
+                shareKey: ids.shareKey,
+            })
+        ),
         ids.changeRequest
-            ? dataFetcher.getChangeRequest({
+            ? throwIfDataError(
-                  spaceId: ids.space,
+                  dataFetcher.getChangeRequest({
-                  changeRequestId: ids.changeRequest,
+                      spaceId: ids.space,
-              })
+                      changeRequestId: ids.changeRequest,
+                  })
+              )
             : null,
     ]);
 
     const revisionId = changeRequest?.revision ?? ids.revision ?? space.revision;
 
-    const pages = await dataFetcher.getRevisionPages({
+    const pages = await throwIfDataError(
-        spaceId: ids.space,
+        dataFetcher.getRevisionPages({
-        revisionId,
+            spaceId: ids.space,
-        // We only care about the Git metadata when the Git sync is enabled,
+            revisionId,
-        // otherwise we can optimize performance by not fetching it
+            // We only care about the Git metadata when the Git sync is enabled,
-        metadata: !!space.gitSync,
+            // otherwise we can optimize performance by not fetching it
-    });
+            metadata: !!space.gitSync,
+        })
+    );
 
     return {
         ...baseContext,
@@ -281,9 +309,39 @@ export async function fetchSpaceContextByIds(
     };
 }
 
-function parseSiteSectionsList(structure: SiteStructure, siteSectionId: string) {
+/**
-    const sections = getSiteStructureSections(structure);
+ * Check if the context is the root one for a site.
-    const section = sections.find((section) => section.id === siteSectionId);
+ * Meaning we are on the default section / space.
-    assert(section, 'A section must be defined when there are multiple sections');
+ */
-    return { list: sections, current: section } satisfies SiteSections;
+export function checkIsRootSiteContext(context: GitBookSiteContext): boolean {
+    const { structure } = context;
+    switch (structure.type) {
+        case 'sections': {
+            return getSiteStructureSections(structure, { ignoreGroups: true }).some(
+                (structure) =>
+                    structure.default &&
+                    structure.id === context.sections?.current.id &&
+                    structure.siteSpaces.some(
+                        (siteSpace) => siteSpace.default && siteSpace.id === context.siteSpace.id
+                    )
+            );
+        }
+        case 'siteSpaces': {
+            return structure.structure.some(
+                (siteSpace) => siteSpace.default && siteSpace.id === context.siteSpace.id
+            );
+        }
+    }
+}
+
+function parseSiteSectionsAndGroups(structure: SiteStructure, siteSectionId: string) {
+    const sectionsAndGroups = getSiteStructureSections(structure, { ignoreGroups: false });
+    const section = parseCurrentSection(structure, siteSectionId);
+    assert(section, 'A section must be defined when there are multiple sections');
+    return { list: sectionsAndGroups, current: section } satisfies SiteSections;
+}
+
+function parseCurrentSection(structure: SiteStructure, siteSectionId: string) {
+    const sections = getSiteStructureSections(structure, { ignoreGroups: true });
+    return sections.find((section) => section.id === siteSectionId);
 }

packages/gitbook-v2/src/lib/data/api.ts

@@ -1,154 +1,190 @@
-import { unstable_cacheLife as cacheLife, unstable_cacheTag as cacheTag } from 'next/cache';
+import { trace } from '@/lib/tracing';
-import { ComputedContentSource, GitBookAPI } from '@gitbook/api';
-import { GITBOOK_API_TOKEN, GITBOOK_API_URL, GITBOOK_USER_AGENT } from '@v2/lib/env';
-import { GitBookDataFetcher } from './types';
 import {
-    getChangeRequestCacheTag,
+    type ComputedContentSource,
-    getHostnameCacheTag,
+    GitBookAPI,
-    getOpenAPISpecCacheTag,
+    type GitBookAPIServiceBinding,
-    getSiteCacheTag,
+    type RenderIntegrationUI,
-    getSpaceCacheTag,
+} from '@gitbook/api';
-} from '../cache';
+import { getCacheTag, getComputedContentSourceCacheTags } from '@gitbook/cache-tags';
+import { GITBOOK_API_TOKEN, GITBOOK_API_URL, GITBOOK_USER_AGENT } from '@v2/lib/env';
+import { unstable_cacheLife as cacheLife, unstable_cacheTag as cacheTag } from 'next/cache';
+import { wrapDataFetcherError } from './errors';
+import type { GitBookDataFetcher } from './types';
 
 interface DataFetcherInput {
-    /**
-     * API host to use.
-     */
-    apiEndpoint: string;
-
     /**
      * API token.
      */
     apiToken: string | null;
 }
 
-const commonInput: DataFetcherInput = {
-    apiEndpoint: GITBOOK_API_URL,
-    apiToken: GITBOOK_API_TOKEN,
-};
-
 /**
  * Create a data fetcher using an API token.
  * The data are being cached by Next.js built-in cache.
  */
-export function createDataFetcher(input: DataFetcherInput = commonInput): GitBookDataFetcher {
+export function createDataFetcher(
+    input: DataFetcherInput = { apiToken: null }
+): GitBookDataFetcher {
     return {
-        apiEndpoint: input.apiEndpoint,
+        async api() {
+            return apiClient(input);
+        },
+
+        withToken({ apiToken }) {
+            return createDataFetcher({
+                apiToken,
+            });
+        },
 
         //
         // API that are tied to the token
         //
         getPublishedContentSite(params) {
-            return getPublishedContentSite(input, {
+            return trace('getPublishedContentSite', () =>
-                organizationId: params.organizationId,
+                getPublishedContentSite(input, {
-                siteId: params.siteId,
+                    organizationId: params.organizationId,
-                siteShareKey: params.siteShareKey,
+                    siteId: params.siteId,
-            });
+                    siteShareKey: params.siteShareKey,
+                })
+            );
         },
         getSiteRedirectBySource(params) {
-            return getSiteRedirectBySource(input, {
+            return trace('getSiteRedirectBySource', () =>
-                organizationId: params.organizationId,
+                getSiteRedirectBySource(input, {
-                siteId: params.siteId,
+                    organizationId: params.organizationId,
-                siteShareKey: params.siteShareKey,
+                    siteId: params.siteId,
-                source: params.source,
+                    siteShareKey: params.siteShareKey,
-            });
+                    source: params.source,
+                })
+            );
         },
         getRevision(params) {
-            return getRevision(input, {
+            return trace('getRevision', () =>
-                spaceId: params.spaceId,
+                getRevision(input, {
-                revisionId: params.revisionId,
+                    spaceId: params.spaceId,
-                metadata: params.metadata,
+                    revisionId: params.revisionId,
-            });
+                    metadata: params.metadata,
+                })
+            );
         },
         getRevisionPages(params) {
-            return getRevisionPages(input, {
+            return trace('getRevisionPages', () =>
-                spaceId: params.spaceId,
+                getRevisionPages(input, {
-                revisionId: params.revisionId,
+                    spaceId: params.spaceId,
-                metadata: params.metadata,
+                    revisionId: params.revisionId,
-            });
+                    metadata: params.metadata,
+                })
+            );
         },
         getRevisionFile(params) {
-            return getRevisionFile(input, {
+            return trace('getRevisionFile', () =>
-                spaceId: params.spaceId,
+                getRevisionFile(input, {
-                revisionId: params.revisionId,
+                    spaceId: params.spaceId,
-                fileId: params.fileId,
+                    revisionId: params.revisionId,
-            });
+                    fileId: params.fileId,
+                })
+            );
         },
         getRevisionPageByPath(params) {
-            return getRevisionPageByPath(input, {
+            return trace('getRevisionPageByPath', () =>
-                spaceId: params.spaceId,
+                getRevisionPageByPath(input, {
-                revisionId: params.revisionId,
+                    spaceId: params.spaceId,
-                path: params.path,
+                    revisionId: params.revisionId,
-            });
+                    path: params.path,
+                })
+            );
         },
         getReusableContent(params) {
-            return getReusableContent(input, {
+            return trace('getReusableContent', () =>
-                spaceId: params.spaceId,
+                getReusableContent(input, {
-                revisionId: params.revisionId,
+                    spaceId: params.spaceId,
-                reusableContentId: params.reusableContentId,
+                    revisionId: params.revisionId,
-            });
+                    reusableContentId: params.reusableContentId,
+                })
+            );
         },
         getLatestOpenAPISpecVersionContent(params) {
-            return getLatestOpenAPISpecVersionContent(input, {
+            return trace('getLatestOpenAPISpecVersionContent', () =>
-                organizationId: params.organizationId,
+                getLatestOpenAPISpecVersionContent(input, {
-                slug: params.slug,
+                    organizationId: params.organizationId,
-            });
+                    slug: params.slug,
+                })
+            );
         },
         getSpace(params) {
-            return getSpace(input, {
+            return trace('getSpace', () =>
-                spaceId: params.spaceId,
+                getSpace(input, {
-                shareKey: params.shareKey,
+                    spaceId: params.spaceId,
-            });
+                    shareKey: params.shareKey,
+                })
+            );
         },
         getChangeRequest(params) {
-            return getChangeRequest(input, {
+            return trace('getChangeRequest', () =>
-                spaceId: params.spaceId,
+                getChangeRequest(input, {
-                changeRequestId: params.changeRequestId,
+                    spaceId: params.spaceId,
-            });
+                    changeRequestId: params.changeRequestId,
+                })
+            );
         },
         getDocument(params) {
-            return getDocument(input, {
+            return trace('getDocument', () =>
-                spaceId: params.spaceId,
+                getDocument(input, {
-                documentId: params.documentId,
+                    spaceId: params.spaceId,
-            });
+                    documentId: params.documentId,
+                })
+            );
         },
         getComputedDocument(params) {
-            return getComputedDocument(input, {
+            return trace('getComputedDocument', () =>
-                spaceId: params.spaceId,
+                getComputedDocument(input, {
-                source: params.source,
+                    organizationId: params.organizationId,
-            });
+                    spaceId: params.spaceId,
+                    source: params.source,
+                    seed: params.seed,
+                })
+            );
+        },
+        getEmbedByUrl(params) {
+            return trace('getEmbedByUrl', () =>
+                getEmbedByUrl(input, {
+                    url: params.url,
+                    spaceId: params.spaceId,
+                })
+            );
+        },
+        searchSiteContent(params) {
+            return trace('searchSiteContent', () => searchSiteContent(input, params));
         },
 
+        renderIntegrationUi(params) {
+            return trace('renderIntegrationUi', () =>
+                renderIntegrationUi(input, {
+                    integrationName: params.integrationName,
+                    request: params.request,
+                })
+            );
+        },
         //
         // API that are not tied to the token
         // where the data is the same for all users
         //
         getUserById(userId) {
-            return getUserById(commonInput, userId);
+            return trace('getUserById', () => getUserById({ apiToken: null }, { userId }));
-        },
-        getPublishedContentByUrl(params) {
-            return getPublishedContentByUrl(commonInput, {
-                url: params.url,
-                visitorAuthToken: params.visitorAuthToken,
-                redirectOnError: params.redirectOnError,
-            });
         },
     };
 }
 
-async function getUserById(input: DataFetcherInput, userId: string) {
+async function getUserById(input: DataFetcherInput, params: { userId: string }) {
     'use cache';
 
-    try {
+    cacheLife('days');
-        const res = await getAPI(input).users.getUserById(userId);
-        return res.data;
-    } catch (error) {
-        if (checkHasErrorCode(error, 404)) {
-            return null;
-        }
 
-        throw error;
+    return wrapDataFetcherError(async () => {
-    }
+        const api = await apiClient(input);
+        const res = await api.users.getUserById(params.userId);
+        return res.data;
+    });
 }
 
 async function getSpace(
@@ -156,16 +192,25 @@ async function getSpace(
     params: {
         spaceId: string;
         shareKey: string | undefined;
-    },
+    }
 ) {
     'use cache';
 
-    cacheTag(getSpaceCacheTag(params.spaceId));
+    cacheLife('days');
+    cacheTag(
+        getCacheTag({
+            tag: 'space',
+            space: params.spaceId,
+        })
+    );
 
-    const res = await getAPI(input).spaces.getSpaceById(params.spaceId, {
+    return wrapDataFetcherError(async () => {
-        shareKey: params.shareKey,
+        const api = await apiClient(input);
+        const res = await api.spaces.getSpaceById(params.spaceId, {
+            shareKey: params.shareKey,
+        });
+        return res.data;
     });
-    return res.data;
 }
 
 async function getChangeRequest(
@@ -173,24 +218,24 @@ async function getChangeRequest(
     params: {
         spaceId: string;
         changeRequestId: string;
-    },
+    }
 ) {
     'use cache';
 
-    try {
+    cacheLife('minutes');
-        const res = await getAPI(input).spaces.getChangeRequestById(
-            params.spaceId,
-            params.changeRequestId,
-        );
-        cacheTag(getChangeRequestCacheTag(params.spaceId, res.data.id));
-        return res.data;
-    } catch (error) {
-        if (checkHasErrorCode(error, 404)) {
-            return null;
-        }
 
-        throw error;
+    return wrapDataFetcherError(async () => {
-    }
+        const api = await apiClient(input);
+        const res = await api.spaces.getChangeRequestById(params.spaceId, params.changeRequestId);
+        cacheTag(
+            getCacheTag({
+                tag: 'change-request',
+                space: params.spaceId,
+                changeRequest: res.data.id,
+            })
+        );
+        return res.data;
+    });
 }
 
 async function getRevision(
@@ -199,14 +244,19 @@ async function getRevision(
         spaceId: string;
         revisionId: string;
         metadata: boolean;
-    },
+    }
 ) {
     'use cache';
 
-    const res = await getAPI(input).spaces.getRevisionById(params.spaceId, params.revisionId, {
+    cacheLife('max');
-        metadata: params.metadata,
+
+    return wrapDataFetcherError(async () => {
+        const api = await apiClient(input);
+        const res = await api.spaces.getRevisionById(params.spaceId, params.revisionId, {
+            metadata: params.metadata,
+        });
+        return res.data;
     });
-    return res.data;
 }
 
 async function getRevisionPages(
@@ -215,18 +265,19 @@ async function getRevisionPages(
         spaceId: string;
         revisionId: string;
         metadata: boolean;
-    },
+    }
 ) {
     'use cache';
 
-    const res = await getAPI(input).spaces.listPagesInRevisionById(
+    cacheLife('max');
-        params.spaceId,
+
-        params.revisionId,
+    return wrapDataFetcherError(async () => {
-        {
+        const api = await apiClient(input);
+        const res = await api.spaces.listPagesInRevisionById(params.spaceId, params.revisionId, {
             metadata: params.metadata,
-        },
+        });
-    );
+        return res.data.pages;
-    return res.data.pages;
+    });
 }
 
 async function getRevisionFile(
@@ -235,24 +286,22 @@ async function getRevisionFile(
         spaceId: string;
         revisionId: string;
         fileId: string;
-    },
+    }
 ) {
     'use cache';
 
-    try {
+    cacheLife('max');
-        const res = await getAPI(input).spaces.getFileInRevisionById(
+
+    return wrapDataFetcherError(async () => {
+        const api = await apiClient(input);
+        const res = await api.spaces.getFileInRevisionById(
             params.spaceId,
             params.revisionId,
             params.fileId,
+            {}
         );
         return res.data;
-    } catch (error) {
+    });
-        if (checkHasErrorCode(error, 404)) {
-            return null;
-        }
-
-        throw error;
-    }
 }
 
 async function getRevisionPageByPath(
@@ -261,27 +310,24 @@ async function getRevisionPageByPath(
         spaceId: string;
         revisionId: string;
         path: string;
-    },
+    }
 ) {
     'use cache';
 
-    const encodedPath = encodeURIComponent(params.path);
+    cacheLife('max');
 
-    try {
+    const encodedPath = encodeURIComponent(params.path);
-        const res = await getAPI(input).spaces.getPageInRevisionByPath(
+    return wrapDataFetcherError(async () => {
+        const api = await apiClient(input);
+        const res = await api.spaces.getPageInRevisionByPath(
             params.spaceId,
             params.revisionId,
             encodedPath,
+            {}
         );
 
         return res.data;
-    } catch (error) {
+    });
-        if (checkHasErrorCode(error, 404)) {
-            return null;
-        }
-
-        throw error;
-    }
 }
 
 async function getDocument(
@@ -289,27 +335,50 @@ async function getDocument(
     params: {
         spaceId: string;
         documentId: string;
-    },
+    }
 ) {
     'use cache';
 
-    const res = await getAPI(input).spaces.getDocumentById(params.spaceId, params.documentId);
+    cacheLife('max');
-    return res.data;
+
+    return wrapDataFetcherError(async () => {
+        const api = await apiClient(input);
+        const res = await api.spaces.getDocumentById(params.spaceId, params.documentId, {});
+        return res.data;
+    });
 }
 
 async function getComputedDocument(
     input: DataFetcherInput,
     params: {
         spaceId: string;
+        organizationId: string;
         source: ComputedContentSource;
-    },
+        seed: string;
+    }
 ) {
     'use cache';
 
-    const res = await getAPI(input).spaces.getComputedDocument(params.spaceId, {
+    cacheLife('days');
-        source: params.source,
+
+    cacheTag(
+        ...getComputedContentSourceCacheTags(
+            {
+                spaceId: params.spaceId,
+                organizationId: params.organizationId,
+            },
+            params.source
+        )
+    );
+
+    return wrapDataFetcherError(async () => {
+        const api = await apiClient(input);
+        const res = await api.spaces.getComputedDocument(params.spaceId, {
+            source: params.source,
+            seed: params.seed,
+        });
+        return res.data;
     });
-    return res.data;
 }
 
 async function getReusableContent(
@@ -318,24 +387,21 @@ async function getReusableContent(
         spaceId: string;
         revisionId: string;
         reusableContentId: string;
-    },
+    }
 ) {
     'use cache';
 
-    try {
+    cacheLife('max');
-        const res = await getAPI(input).spaces.getReusableContentInRevisionById(
+
+    return wrapDataFetcherError(async () => {
+        const api = await apiClient(input);
+        const res = await api.spaces.getReusableContentInRevisionById(
             params.spaceId,
             params.revisionId,
-            params.reusableContentId,
+            params.reusableContentId
         );
         return res.data;
-    } catch (error) {
+    });
-        if (checkHasErrorCode(error, 404)) {
-            return null;
-        }
-
-        throw error;
-    }
 }
 
 async function getLatestOpenAPISpecVersionContent(
@@ -343,53 +409,27 @@ async function getLatestOpenAPISpecVersionContent(
     params: {
         organizationId: string;
         slug: string;
-    },
+    }
 ) {
     'use cache';
 
-    cacheTag(getOpenAPISpecCacheTag(params.organizationId, params.slug));
+    cacheTag(
+        getCacheTag({
+            tag: 'openapi',
+            organization: params.organizationId,
+            openAPISpec: params.slug,
+        })
+    );
+    cacheLife('days');
 
-    try {
+    return wrapDataFetcherError(async () => {
-        const res = await getAPI(input).orgs.getLatestOpenApiSpecVersionContent(
+        const api = await apiClient(input);
+        const res = await api.orgs.getLatestOpenApiSpecVersionContent(
             params.organizationId,
-            params.slug,
+            params.slug
         );
         return res.data;
-    } catch (error) {
-        if (checkHasErrorCode(error, 404)) {
-            return null;
-        }
-
-        throw error;
-    }
-}
-
-async function getPublishedContentByUrl(
-    input: DataFetcherInput,
-    params: {
-        url: string;
-        visitorAuthToken: string | null;
-        redirectOnError: boolean;
-    },
-) {
-    'use cache';
-
-    const { url, visitorAuthToken, redirectOnError } = params;
-
-    const hostname = new URL(url).hostname;
-    cacheTag(getHostnameCacheTag(hostname));
-
-    const res = await getAPI(input).urls.getPublishedContentByUrl({
-        url,
-        visitorAuthToken: visitorAuthToken ?? undefined,
-        redirectOnError,
     });
-
-    if ('site' in res.data) {
-        cacheTag(getSiteCacheTag(res.data.site));
-    }
-
-    return res.data;
 }
 
 async function getPublishedContentSite(
@@ -398,18 +438,25 @@ async function getPublishedContentSite(
         organizationId: string;
         siteId: string;
         siteShareKey: string | undefined;
-    },
+    }
 ) {
     'use cache';
-    cacheTag(getSiteCacheTag(params.siteId));
+
-    const res = await getAPI(input).orgs.getPublishedContentSite(
+    cacheLife('days');
-        params.organizationId,
+    cacheTag(
-        params.siteId,
+        getCacheTag({
-        {
+            tag: 'site',
-            shareKey: params.siteShareKey,
+            site: params.siteId,
-        },
+        })
     );
-    return res.data;
+
+    return wrapDataFetcherError(async () => {
+        const api = await apiClient(input);
+        const res = await api.orgs.getPublishedContentSite(params.organizationId, params.siteId, {
+            shareKey: params.siteShareKey,
+        });
+        return res.data;
+    });
 }
 
 async function getSiteRedirectBySource(
@@ -419,47 +466,127 @@ async function getSiteRedirectBySource(
         siteId: string;
         siteShareKey: string | undefined;
         source: string;
-    },
+    }
 ) {
     'use cache';
 
-    try {
+    cacheTag(
-        const res = await getAPI(input).orgs.getSiteRedirectBySource(
+        getCacheTag({
-            params.organizationId,
+            tag: 'site',
-            params.siteId,
+            site: params.siteId,
-            {
+        })
-                shareKey: params.siteShareKey,
+    );
-                source: params.source,
+    cacheLife('days');
-            },
+
-        );
+    return wrapDataFetcherError(async () => {
+        const api = await apiClient(input);
+        const res = await api.orgs.getSiteRedirectBySource(params.organizationId, params.siteId, {
+            shareKey: params.siteShareKey,
+            source: params.source,
+        });
 
         return res.data;
-    } catch (error) {
+    });
-        // 422 is returned when the source is invalid
-        // we don't want to throw but just return null
-        if (checkHasErrorCode(error, 422)) {
-            return null;
-        }
-
-        if (checkHasErrorCode(error, 404)) {
-            return null;
-        }
-
-        throw error;
-    }
 }
 
-function getAPI(input: DataFetcherInput) {
+async function getEmbedByUrl(
-    const { apiEndpoint, apiToken } = input;
+    input: DataFetcherInput,
+    params: {
+        url: string;
+        spaceId: string;
+    }
+) {
+    'use cache';
+
+    cacheLife('weeks');
+
+    return wrapDataFetcherError(async () => {
+        const api = await apiClient(input);
+        const res = await api.spaces.getEmbedByUrlInSpace(params.spaceId, { url: params.url });
+        return res.data;
+    });
+}
+
+async function searchSiteContent(
+    input: DataFetcherInput,
+    params: Parameters<GitBookDataFetcher['searchSiteContent']>[0]
+) {
+    'use cache';
+
+    const { organizationId, siteId, query, scope } = params;
+
+    cacheLife('days');
+
+    return wrapDataFetcherError(async () => {
+        const api = await apiClient(input);
+        const res = await api.orgs.searchSiteContent(organizationId, siteId, {
+            query,
+            ...scope,
+        });
+        return res.data.items;
+    });
+}
+
+async function renderIntegrationUi(
+    input: DataFetcherInput,
+    params: {
+        integrationName: string;
+        request: RenderIntegrationUI;
+    }
+) {
+    'use cache';
+
+    cacheTag(getCacheTag({ tag: 'integration', integration: params.integrationName }));
+    cacheLife('days');
+
+    return wrapDataFetcherError(async () => {
+        const api = await apiClient(input);
+        const res = await api.integrations.renderIntegrationUiWithPost(
+            params.integrationName,
+            params.request
+        );
+        return res.data;
+    });
+}
+
+let loggedServiceBinding = false;
+
+/**
+ * Create a new API client.
+ */
+export async function apiClient(input: DataFetcherInput = { apiToken: null }) {
+    const { apiToken } = input;
+    let serviceBinding: GitBookAPIServiceBinding | undefined;
+
+    try {
+        // HACK: This is a workaround to avoid webpack trying to bundle this cloudflare only module
+        // @ts-ignore
+        const { env } = await import(
+            /* webpackIgnore: true */ `${'__cloudflare:workers'.replaceAll('_', '')}`
+        );
+        serviceBinding = env.GITBOOK_API;
+        if (!loggedServiceBinding) {
+            loggedServiceBinding = true;
+            if (serviceBinding) {
+                // biome-ignore lint/suspicious/noConsole: we want to log here
+                console.log(`using service binding for the API (${GITBOOK_API_URL})`);
+            } else {
+                // biome-ignore lint/suspicious/noConsole: we want to log here
+                console.warn(`no service binding for the API (${GITBOOK_API_URL})`);
+            }
+        }
+    } catch (error) {
+        if (process.env.NODE_ENV === 'production' && !process.env.VERCEL) {
+            throw error;
+        }
+    }
+
     const api = new GitBookAPI({
-        authToken: apiToken ?? undefined,
+        authToken: apiToken || GITBOOK_API_TOKEN || undefined,
-        endpoint: apiEndpoint,
+        endpoint: GITBOOK_API_URL,
         userAgent: GITBOOK_USER_AGENT,
+        serviceBinding,
     });
 
     return api;
 }
-
-function checkHasErrorCode(error: unknown, code: number) {
-    return error instanceof Error && 'code' in error && error.code === code;
-}

packages/gitbook-v2/src/lib/data/errors.ts

@@ -0,0 +1,115 @@
+import { GitBookAPIError } from '@gitbook/api';
+import type { DataFetcherErrorData, DataFetcherResponse } from './types';
+
+export class DataFetcherError extends Error {
+    constructor(
+        message: string,
+        public readonly code: number
+    ) {
+        super(message);
+    }
+}
+
+/**
+ * Throw an error if the response contains an error.
+ */
+export function throwIfDataError<T>(response: DataFetcherResponse<T>): T;
+export function throwIfDataError<T>(response: Promise<DataFetcherResponse<T>>): Promise<T>;
+export function throwIfDataError<T>(
+    response: DataFetcherResponse<T> | Promise<DataFetcherResponse<T>>
+): T | Promise<T> {
+    if (response instanceof Promise) {
+        return response.then((result) => throwIfDataError(result));
+    }
+
+    if (response.error) {
+        throw new DataFetcherError(response.error.message, response.error.code);
+    }
+    return response.data;
+}
+
+/**
+ * Get the data from the response or null if there is an "Not found" error.
+ */
+export function getDataOrNull<T>(
+    response: DataFetcherResponse<T>,
+    ignoreErrors?: number[]
+): T | null;
+export function getDataOrNull<T>(
+    response: Promise<DataFetcherResponse<T>>,
+    ignoreErrors?: number[]
+): Promise<T | null>;
+export function getDataOrNull<T>(
+    response: DataFetcherResponse<T> | Promise<DataFetcherResponse<T>>,
+    ignoreErrors: number[] = [404]
+): T | null | Promise<T | null> {
+    if (response instanceof Promise) {
+        return response.then((result) => getDataOrNull(result, ignoreErrors));
+    }
+
+    if (response.error) {
+        if (ignoreErrors.includes(response.error.code)) return null;
+        throw new DataFetcherError(response.error.message, response.error.code);
+    }
+    return response.data;
+}
+
+/**
+ * Ignore error for an API or data call.
+ */
+export async function ignoreDataThrownError<T>(promise: Promise<T>): Promise<T | null> {
+    try {
+        return await promise;
+    } catch (error) {
+        getExposableError(error as Error);
+        return null;
+    }
+}
+
+/**
+ * Ignore all errors for an API or data call.
+ */
+export async function ignoreAllThrownError<T>(promise: Promise<T>): Promise<T | null> {
+    try {
+        return await promise;
+    } catch (error) {
+        console.warn('Ignoring error', error);
+        return null;
+    }
+}
+
+/**
+ * Wrap an async execution to handle errors and return a DataFetcherResponse.
+ */
+export async function wrapDataFetcherError<T>(
+    fn: () => Promise<T>
+): Promise<DataFetcherResponse<T>> {
+    try {
+        return { data: await fn() };
+    } catch (error) {
+        return {
+            error: getExposableError(error as Error),
+        };
+    }
+}
+
+/**
+ * Get a data fetcher exposable error from a JS error.
+ */
+export function getExposableError(error: Error): DataFetcherErrorData {
+    if (error instanceof GitBookAPIError) {
+        return {
+            code: error.code,
+            message: error.errorMessage,
+        };
+    }
+
+    if (error instanceof DataFetcherError) {
+        return {
+            code: error.code,
+            message: error.message,
+        };
+    }
+
+    throw error;
+}

packages/gitbook-v2/src/lib/data/index.ts

@@ -1,4 +1,6 @@
 export * from './api';
 export * from './types';
-export * from './utils';
+export * from './pages';
 export * from './urls';
+export * from './errors';
+export * from './lookup';

packages/gitbook-v2/src/lib/data/lookup.ts

@@ -0,0 +1,132 @@
+import { race, tryCatch } from '@/lib/async';
+import { joinPath } from '@/lib/paths';
+import { trace } from '@/lib/tracing';
+import type { PublishedSiteContentLookup } from '@gitbook/api';
+import { apiClient } from './api';
+import { getExposableError } from './errors';
+import type { DataFetcherResponse } from './types';
+import { getURLLookupAlternatives, stripURLSearch } from './urls';
+
+/**
+ * Lookup a content by its URL using the GitBook API.
+ * To optimize caching, we try multiple lookup alternatives and return the first one that matches.
+ */
+export async function getPublishedContentByURL(input: {
+    url: string;
+    visitorAuthToken: string | null;
+    redirectOnError: boolean;
+    apiToken: string | null;
+}): Promise<DataFetcherResponse<PublishedSiteContentLookup>> {
+    const lookupURL = new URL(input.url);
+    const url = stripURLSearch(lookupURL);
+    const lookup = getURLLookupAlternatives(url);
+
+    const result = await race(lookup.urls, async (alternative, { signal }) => {
+        const api = await apiClient({ apiToken: input.apiToken });
+
+        const callResult = await trace(
+            {
+                operation: 'getPublishedContentByURL',
+                name: alternative.url,
+            },
+            () =>
+                tryCatch(
+                    api.urls.getPublishedContentByUrl(
+                        {
+                            url: alternative.url,
+                            visitorAuthToken: input.visitorAuthToken ?? undefined,
+                            redirectOnError: input.redirectOnError,
+                        },
+                        {
+                            signal,
+                        }
+                    )
+                )
+        );
+
+        if (callResult.error) {
+            if (alternative.primary) {
+                // We only return an error for the primary alternative (full URL),
+                // as other parts could result in errors due to the URL being incomplete (share links, etc).
+                return { error: callResult.error };
+            }
+            return null;
+        }
+
+        const {
+            data: { data },
+        } = callResult;
+
+        if ('redirect' in data) {
+            if (alternative.primary) {
+                // Append the path to the redirect URL
+                // because we might have matched a shorter path and the redirect is relative to it
+                if (alternative.extraPath) {
+                    if (data.target === 'content') {
+                        const redirect = new URL(data.redirect);
+                        redirect.pathname = joinPath(redirect.pathname, alternative.extraPath);
+                        data.redirect = redirect.toString();
+                    } else {
+                        const redirect = new URL(data.redirect);
+                        if (redirect.searchParams.has('location')) {
+                            redirect.searchParams.set(
+                                'location',
+                                joinPath(
+                                    redirect.searchParams.get('location') ?? '',
+                                    alternative.extraPath
+                                )
+                            );
+                            data.redirect = redirect.toString();
+                        }
+                    }
+                }
+
+                return { data };
+            }
+
+            return null;
+        }
+
+        /**
+         * We use the following criteria to determine if the lookup result is the right one:
+         * - the primary alternative was resolved (because that's the longest or most inclusive path)
+         * - the resolution of the site URL is complete (because we want to resolve the deepest path possible)
+         *
+         * In both cases, the idea is to use the deepest/longest/most inclusive path to resolve the content.
+         */
+        if (alternative.primary || ('site' in data && data.complete)) {
+            const changeRequest = data.changeRequest ?? lookup.changeRequest;
+            const revision = data.revision ?? lookup.revision;
+
+            const siteResult: PublishedSiteContentLookup = {
+                ...data,
+                basePath: joinPath(data.basePath, lookup.basePath ?? ''),
+                pathname: joinPath(data.pathname, alternative.extraPath),
+                ...(changeRequest ? { changeRequest } : {}),
+                ...(revision ? { revision } : {}),
+            };
+            return { data: siteResult };
+        }
+
+        return null;
+    });
+
+    if (!result) {
+        return {
+            error: {
+                code: 404,
+                message: 'No content found',
+            },
+        };
+    }
+
+    if (result.error) {
+        return {
+            error: getExposableError(result.error),
+        };
+    }
+
+    return {
+        data: result.data,
+    };
+}

packages/gitbook-v2/src/lib/data/pages.ts

@@ -0,0 +1,30 @@
+import type { JSONDocument, RevisionPageDocument, Space } from '@gitbook/api';
+import { getDataOrNull } from './errors';
+import type { GitBookDataFetcher } from './types';
+
+/**
+ * Get the document for a page.
+ */
+export async function getPageDocument(
+    dataFetcher: GitBookDataFetcher,
+    space: Space,
+    page: RevisionPageDocument
+): Promise<JSONDocument | null> {
+    if (page.documentId) {
+        return getDataOrNull(
+            dataFetcher.getDocument({ spaceId: space.id, documentId: page.documentId })
+        );
+    }
+    if ('computed' in page && page.computed) {
+        return getDataOrNull(
+            dataFetcher.getComputedDocument({
+                organizationId: space.organization,
+                spaceId: space.id,
+                source: page.computed,
+                seed: page.computedSeed,
+            })
+        );
+    }
+
+    return null;
+}

packages/gitbook-v2/src/lib/data/types.ts

@@ -1,28 +1,41 @@
 import type * as api from '@gitbook/api';
 
+export type DataFetcherErrorData = {
+    code: number;
+    message: string;
+};
+
+export type DataFetcherResponse<T> =
+    | {
+          data: T;
+          error?: undefined;
+      }
+    | {
+          error: DataFetcherErrorData;
+          data?: undefined;
+      };
+
 /**
  * Generic fetcher for GitBook data.
  * It is used between v1 and v2.
  */
 export interface GitBookDataFetcher {
     /**
-     * Endpoint of the API.
+     * Get an API client for the current context.
      */
-    apiEndpoint: string;
+    api(): Promise<api.GitBookAPI>;
+
+    /**
+     * Create a data fetcher authenticated with a specific token.
+     */
+    withToken(input: {
+        apiToken: string;
+    }): GitBookDataFetcher;
 
     /**
      * Get a user by its ID.
      */
-    getUserById(userId: string): Promise<api.User | null>;
+    getUserById(userId: string): Promise<DataFetcherResponse<api.User>>;
-
-    /**
-     * Get a published content by its URL.
-     */
-    getPublishedContentByUrl(params: {
-        url: string;
-        visitorAuthToken: string | null;
-        redirectOnError: boolean;
-    }): Promise<api.PublishedSiteContentLookup>;
 
     /**
      * Get a published content site by its organization ID and site ID.
@@ -31,12 +44,14 @@ export interface GitBookDataFetcher {
         organizationId: string;
         siteId: string;
         siteShareKey: string | undefined;
-    }): Promise<api.PublishedContentSite>;
+    }): Promise<DataFetcherResponse<api.PublishedContentSite>>;
 
     /**
      * Get a space by its ID.
      */
-    getSpace(params: { spaceId: string; shareKey: string | undefined }): Promise<api.Space>;
+    getSpace(params: { spaceId: string; shareKey: string | undefined }): Promise<
+        DataFetcherResponse<api.Space>
+    >;
 
     /**
      * Get a change request by its space ID and change request ID.
@@ -44,7 +59,7 @@ export interface GitBookDataFetcher {
     getChangeRequest(params: {
         spaceId: string;
         changeRequestId: string;
-    }): Promise<api.ChangeRequest | null>;
+    }): Promise<DataFetcherResponse<api.ChangeRequest>>;
 
     /**
      * Get the revision by its space ID and revision ID.
@@ -53,7 +68,7 @@ export interface GitBookDataFetcher {
         spaceId: string;
         revisionId: string;
         metadata: boolean;
-    }): Promise<api.Revision>;
+    }): Promise<DataFetcherResponse<api.Revision>>;
 
     /**
      * Get the revision pages by its space ID and revision ID.
@@ -62,7 +77,7 @@ export interface GitBookDataFetcher {
         spaceId: string;
         revisionId: string;
         metadata: boolean;
-    }): Promise<api.RevisionPage[]>;
+    }): Promise<DataFetcherResponse<api.RevisionPage[]>>;
 
     /**
      * Get a revision file by its space ID, revision ID and file ID.
@@ -71,7 +86,7 @@ export interface GitBookDataFetcher {
         spaceId: string;
         revisionId: string;
         fileId: string;
-    }): Promise<api.RevisionFile | null>;
+    }): Promise<DataFetcherResponse<api.RevisionFile>>;
 
     /**
      * Get a revision page by its path.
@@ -80,20 +95,24 @@ export interface GitBookDataFetcher {
         spaceId: string;
         revisionId: string;
         path: string;
-    }): Promise<api.RevisionPageDocument | api.RevisionPageGroup | null>;
+    }): Promise<DataFetcherResponse<api.RevisionPageDocument | api.RevisionPageGroup>>;
 
     /**
      * Get a document by its space ID and document ID.
      */
-    getDocument(params: { spaceId: string; documentId: string }): Promise<api.JSONDocument>;
+    getDocument(params: { spaceId: string; documentId: string }): Promise<
+        DataFetcherResponse<api.JSONDocument>
+    >;
 
     /**
      * Get a computed document by its space ID and computed source.
      */
     getComputedDocument(params: {
+        organizationId: string;
         spaceId: string;
         source: api.ComputedContentSource;
-    }): Promise<api.JSONDocument>;
+        seed: string;
+    }): Promise<DataFetcherResponse<api.JSONDocument>>;
 
     /**
      * Get a reusable content by its space ID, revision ID and reusable content ID.
@@ -102,7 +121,7 @@ export interface GitBookDataFetcher {
         spaceId: string;
         revisionId: string;
         reusableContentId: string;
-    }): Promise<api.RevisionReusableContent | null>;
+    }): Promise<DataFetcherResponse<api.RevisionReusableContent>>;
 
     /**
      * Get the latest OpenAPI spec version content by its organization ID and slug.
@@ -110,7 +129,7 @@ export interface GitBookDataFetcher {
     getLatestOpenAPISpecVersionContent(params: {
         organizationId: string;
         slug: string;
-    }): Promise<api.OpenAPISpecContent | null>;
+    }): Promise<DataFetcherResponse<api.OpenAPISpecContent>>;
 
     /**
      * Get a site redirect by its source path.
@@ -120,5 +139,35 @@ export interface GitBookDataFetcher {
         siteId: string;
         siteShareKey: string | undefined;
         source: string;
-    }): Promise<{ redirect: api.SiteRedirect | null; target: string } | null>;
+    }): Promise<DataFetcherResponse<{ redirect: api.SiteRedirect | null; target: string }>>;
+
+    /**
+     * Get an embed by its URL.
+     */
+    getEmbedByUrl(params: { url: string; spaceId: string }): Promise<
+        DataFetcherResponse<api.Embed>
+    >;
+
+    /**
+     * Search content in a site.
+     */
+    searchSiteContent(params: {
+        organizationId: string;
+        siteId: string;
+        query: string;
+        scope:
+            | { mode: 'all' }
+            | { mode: 'current'; siteSpaceId: string }
+            | { mode: 'specific'; siteSpaceIds: string[] };
+        /** Cache bust to ensure the search results are fresh when the space is updated. */
+        cacheBust?: string;
+    }): Promise<DataFetcherResponse<api.SearchSpaceResult[]>>;
+
+    /**
+     * Render an integration UI.
+     */
+    renderIntegrationUi(params: {
+        integrationName: string;
+        request: api.RenderIntegrationUI;
+    }): Promise<DataFetcherResponse<api.ContentKitRenderOutput>>;
 }

packages/gitbook-v2/src/lib/data/urls.test.ts

@@ -1,4 +1,4 @@
-import { describe, it, expect } from 'bun:test';
+import { describe, expect, it } from 'bun:test';
 
 import { getURLLookupAlternatives, normalizeURL } from './urls';
 
@@ -68,7 +68,7 @@ describe('getURLLookupAlternatives', () => {
 
     it('should not match before the variant for a variant url', () => {
         expect(
-            getURLLookupAlternatives(new URL('https://test.gitbook.io/v/variant/space')),
+            getURLLookupAlternatives(new URL('https://test.gitbook.io/v/variant/space'))
         ).toEqual({
             revision: undefined,
             changeRequest: undefined,
@@ -85,7 +85,7 @@ describe('getURLLookupAlternatives', () => {
 
     it('should not match before the variant for a variant in a share link', () => {
         expect(
-            getURLLookupAlternatives(new URL('https://test.gitbook.io/sharelink/v/variant/space')),
+            getURLLookupAlternatives(new URL('https://test.gitbook.io/sharelink/v/variant/space'))
         ).toEqual({
             revision: undefined,
             changeRequest: undefined,
@@ -103,8 +103,8 @@ describe('getURLLookupAlternatives', () => {
     it('should not match before a revision in a variant', () => {
         expect(
             getURLLookupAlternatives(
-                new URL('https://test.gitbook.io/v/variant/~/revisions/id/rest'),
+                new URL('https://test.gitbook.io/v/variant/~/revisions/id/rest')
-            ),
+            )
         ).toEqual({
             revision: 'id',
             changeRequest: undefined,
@@ -121,7 +121,7 @@ describe('getURLLookupAlternatives', () => {
 
     it('should not match before a revision ID', () => {
         expect(
-            getURLLookupAlternatives(new URL('https://docs.mycompany.com/~/revisions/id/a/b/c')),
+            getURLLookupAlternatives(new URL('https://docs.mycompany.com/~/revisions/id/a/b/c'))
         ).toEqual({
             revision: 'id',
             changeRequest: undefined,
@@ -138,7 +138,7 @@ describe('getURLLookupAlternatives', () => {
 
     it('should not match before a change request ID', () => {
         expect(
-            getURLLookupAlternatives(new URL('https://docs.mycompany.com/~/changes/id/hello')),
+            getURLLookupAlternatives(new URL('https://docs.mycompany.com/~/changes/id/hello'))
         ).toEqual({
             revision: undefined,
             changeRequest: 'id',
@@ -195,7 +195,7 @@ describe('getURLLookupAlternatives', () => {
 
     it('should match a variant in a share-link', () => {
         expect(
-            getURLLookupAlternatives(new URL('https://test.gitbook.io/sharelink/v/variant/space')),
+            getURLLookupAlternatives(new URL('https://test.gitbook.io/sharelink/v/variant/space'))
         ).toEqual({
             revision: undefined,
             changeRequest: undefined,
@@ -213,8 +213,8 @@ describe('getURLLookupAlternatives', () => {
     it('should match a revision in a variant in a share-link', () => {
         expect(
             getURLLookupAlternatives(
-                new URL('https://test.gitbook.io/sharelink/v/variant/~/revisions/id/a/b/c'),
+                new URL('https://test.gitbook.io/sharelink/v/variant/~/revisions/id/a/b/c')
-            ),
+            )
         ).toEqual({
             revision: 'id',
             changeRequest: undefined,
@@ -232,8 +232,8 @@ describe('getURLLookupAlternatives', () => {
     it('should match a change request in a variant in a share-link', () => {
         expect(
             getURLLookupAlternatives(
-                new URL('https://test.gitbook.io/sharelink/v/variant/~/changes/id/a/b/c'),
+                new URL('https://test.gitbook.io/sharelink/v/variant/~/changes/id/a/b/c')
-            ),
+            )
         ).toEqual({
             revision: undefined,
             changeRequest: 'id',
@@ -367,13 +367,13 @@ describe('getURLLookupAlternatives', () => {
 describe('normalizeURL', () => {
     it('should remove trailing slashes', () => {
         expect(normalizeURL(new URL('https://docs.mycompany.com/hello/'))).toEqual(
-            new URL('https://docs.mycompany.com/hello'),
+            new URL('https://docs.mycompany.com/hello')
         );
     });
 
     it('should remove duplicate slashes', () => {
         expect(normalizeURL(new URL('https://docs.mycompany.com//hello//there'))).toEqual(
-            new URL('https://docs.mycompany.com/hello/there'),
+            new URL('https://docs.mycompany.com/hello/there')
         );
     });
 });

packages/gitbook-v2/src/lib/data/urls.ts

@@ -1,125 +1,3 @@
-import { race, tryCatch } from '@/lib/async';
-import { joinPath } from '@/lib/paths';
-import { GitBookAPI, type GitBookAPIError, type PublishedSiteContentLookup } from '@gitbook/api';
-import { GITBOOK_API_TOKEN, GITBOOK_API_URL, GITBOOK_USER_AGENT } from '@v2/lib/env';
-
-/**
- * Lookup a content by its URL using the GitBook API.
- * To optimize caching, we try multiple lookup alternatives and return the first one that matches.
- */
-export async function getPublishedContentByURL(input: {
-    url: string;
-    visitorAuthToken: string | null;
-    redirectOnError: boolean;
-}): Promise<
-    | { data: PublishedSiteContentLookup; error?: undefined }
-    | { data?: undefined; error: Error | GitBookAPIError }
-> {
-    const lookupURL = new URL(input.url);
-    const url = stripURLSearch(lookupURL);
-    const lookup = getURLLookupAlternatives(url);
-
-    console.log(
-        `lookup content for url "${url.toString()}", with ${lookup.urls.length} alternatives`,
-    );
-
-    const result = await race(lookup.urls, async (alternative, { signal }) => {
-        const api = new GitBookAPI({
-            authToken: GITBOOK_API_TOKEN ?? undefined,
-            endpoint: GITBOOK_API_URL,
-            userAgent: GITBOOK_USER_AGENT,
-        });
-
-        const callResult = await tryCatch(
-            api.urls.getPublishedContentByUrl(
-                {
-                    url: alternative.url,
-                    visitorAuthToken: input.visitorAuthToken ?? undefined,
-                    redirectOnError: input.redirectOnError,
-                    cache: true,
-                },
-                {
-                    signal,
-                    headers: {
-                        'x-gitbook-force-cache': 'true',
-                    },
-                },
-            ),
-        );
-
-        if (callResult.error) {
-            if (alternative.primary) {
-                // We only return an error for the primary alternative (full URL),
-                // as other parts could result in errors due to the URL being incomplete (share links, etc).
-                return { error: callResult.error };
-            }
-            return null;
-        }
-
-        const {
-            data: { data },
-        } = callResult;
-
-        if ('redirect' in data) {
-            if (alternative.primary) {
-                // Append the path to the redirect URL
-                // because we might have matched a shorter path and the redirect is relative to it
-                if (alternative.extraPath) {
-                    if (data.target === 'content') {
-                        const redirect = new URL(data.redirect);
-                        redirect.pathname = joinPath(redirect.pathname, alternative.extraPath);
-                        data.redirect = redirect.toString();
-                    } else {
-                        const redirect = new URL(data.redirect);
-                        if (redirect.searchParams.has('location')) {
-                            redirect.searchParams.set(
-                                'location',
-                                joinPath(
-                                    redirect.searchParams.get('location') ?? '',
-                                    alternative.extraPath,
-                                ),
-                            );
-                            data.redirect = redirect.toString();
-                        }
-                    }
-                }
-
-                return { data };
-            }
-
-            return null;
-        }
-
-        /**
-         * We use the following criteria to determine if the lookup result is the right one:
-         * - the primary alternative was resolved (because that's the longest or most inclusive path)
-         * - the resolution of the site URL is complete (because we want to resolve the deepest path possible)
-         *
-         * In both cases, the idea is to use the deepest/longest/most inclusive path to resolve the content.
-         */
-        if (alternative.primary || ('site' in data && data.complete)) {
-            const siteResult: PublishedSiteContentLookup = {
-                ...data,
-                changeRequest: data.changeRequest ?? lookup.changeRequest,
-                revision: data.revision ?? lookup.revision,
-                basePath: joinPath(data.basePath, lookup.basePath ?? ''),
-                pathname: joinPath(data.pathname, alternative.extraPath),
-            };
-            return { data: siteResult };
-        }
-
-        return null;
-    });
-
-    if (!result) {
-        return {
-            error: new Error('No content found'),
-        };
-    }
-
-    return result;
-}
-
 /**
  * For a given GitBook URL, return a list of alternative URLs that could be matched against to lookup the content.
  * The approach is optimized to aim at reusing cached lookup results as much as possible.
@@ -155,7 +33,7 @@ export function getURLLookupAlternatives(input: URL) {
                 throw new Error(
                     `Invalid extraPath ${extraPath} for url ${adding.toString()}, already set to ${
                         existing.extraPath
-                    }`,
+                    }`
                 );
             }
             return;

packages/gitbook-v2/src/lib/data/utils.ts

@@ -1,19 +0,0 @@
-import { RevisionPageDocument } from '@gitbook/api';
-import { GitBookDataFetcher } from './types';
-
-/**
- * Get the document for a page.
- */
-export async function getPageDocument(
-    dataFetcher: GitBookDataFetcher,
-    spaceId: string,
-    page: RevisionPageDocument,
-) {
-    if (page.documentId) {
-        return dataFetcher.getDocument({ spaceId, documentId: page.documentId });
-    } else if (page.computed) {
-        return dataFetcher.getComputedDocument({ spaceId, source: page.computed });
-    }
-
-    return null;
-}

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

@@ -1,38 +0,0 @@
-/**
- * Main host on which GitBook is running.
- */
-export const GITBOOK_URL =
-    process.env.NODE_ENV === 'development'
-        ? 'http://localhost:3000'
-        : ((process.env.VERCEL_URL ? `https://${process.env.VERCEL_URL}` : undefined) ??
-          process.env.GITBOOK_URL ??
-          '');
-
-/**
- * GitBook app URL.
- */
-export const GITBOOK_APP_URL = process.env.NEXT_PUBLIC_GITBOOK_APP_URL ?? `https://app.gitbook.com`;
-
-/**
- * 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';
-
-/**
- * Whether to disable tracking of events into site insights.
- * This is used to disable tracking in development mode.
- */
-export const GITBOOK_DISABLE_TRACKING = Boolean(
-    !!process.env.GITBOOK_DISABLE_TRACKING || process.env.NODE_ENV !== 'production',
-);

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

@@ -0,0 +1,94 @@
+import 'server-only';
+
+/*
+ * Support both Cloudflare and Vercel, environment variables can be bundled.
+ * To avoid leaking them on the client-side, they should be accessed from this file
+ * and not from the `process.env` object.
+ */
+
+/**
+ * Main host on which GitBook is running.
+ */
+export const GITBOOK_URL =
+    process.env.NODE_ENV === 'development'
+        ? 'http://localhost:3000'
+        : (process.env.GITBOOK_URL ??
+          (process.env.VERCEL_URL ? `https://${process.env.VERCEL_URL}` : undefined) ??
+          '');
+
+/**
+ * URL at which static assets are served.
+ */
+export const GITBOOK_ASSETS_URL =
+    process.env.NODE_ENV === 'development'
+        ? 'http://localhost:3000'
+        : process.env.GITBOOK_ASSETS_PREFIX;
+
+/**
+ * GitBook app URL.
+ */
+export const GITBOOK_APP_URL = process.env.GITBOOK_APP_URL || 'https://app.gitbook.com';
+
+/**
+ * Default GitBook API URL endpoint.
+ */
+export const GITBOOK_API_URL = process.env.GITBOOK_API_URL || 'https://api.gitbook.com';
+
+/**
+ * Default GitBook API URL endpoint, to be shared with the client.
+ */
+export const GITBOOK_API_PUBLIC_URL = process.env.GITBOOK_API_PUBLIC_URL || GITBOOK_API_URL;
+
+/**
+ * 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';
+
+/**
+ * Whether to disable tracking of events into site insights.
+ * This is used to disable tracking in development mode.
+ */
+export const GITBOOK_DISABLE_TRACKING = Boolean(
+    !!process.env.GITBOOK_DISABLE_TRACKING || process.env.NODE_ENV !== 'production'
+);
+
+/**
+ * Hostname serving the integrations.
+ */
+export const GITBOOK_INTEGRATIONS_HOST =
+    process.env.GITBOOK_INTEGRATIONS_HOST || 'integrations.gitbook.com';
+
+/**
+ * Hostname for fonts.
+ */
+export const GITBOOK_FONTS_URL = process.env.GITBOOK_FONTS_URL || 'https://fonts.gitbook.com';
+
+/**
+ * Endpoint to use for resizing images.
+ * It should be a Cloudflare domain with image resizing enabled.
+ */
+export const GITBOOK_IMAGE_RESIZE_URL = process.env.GITBOOK_IMAGE_RESIZE_URL ?? null;
+export const GITBOOK_IMAGE_RESIZE_SIGNING_KEY =
+    process.env.GITBOOK_IMAGE_RESIZE_SIGNING_KEY ?? null;
+
+/**
+ * Endpoint where icons are served.
+ */
+export const GITBOOK_ICONS_URL =
+    process.env.GITBOOK_ICONS_URL || `${GITBOOK_ASSETS_URL || ''}/~gitbook/static/icons`;
+
+/**
+ * Token passed to the icons endpoint.
+ */
+export const GITBOOK_ICONS_TOKEN = process.env.GITBOOK_ICONS_TOKEN;
+
+/**
+ * Secret used to validate requests from the GitBook app.
+ */
+export const GITBOOK_SECRET = process.env.GITBOOK_SECRET ?? null;

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

@@ -0,0 +1,2 @@
+export * from './globals';
+export * from './urls';

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

@@ -0,0 +1,45 @@
+import { GITBOOK_ASSETS_URL, GITBOOK_URL } from './globals';
+
+/**
+ * Check if the URL is a GitBook host URL.
+ */
+export function isGitBookHostURL(input: URL | string): boolean {
+    const url = typeof input === 'string' ? new URL(input) : input;
+
+    if (!GITBOOK_URL) {
+        return false;
+    }
+
+    const gitbookHost = new URL(GITBOOK_URL).host;
+
+    if (url.host === gitbookHost) {
+        return true;
+    }
+
+    // Handle the Cloudflare preview URLs that are prefixed with a random hash
+    // https://developers.cloudflare.com/workers/configuration/previews/
+    if (url.host.endsWith(`-${gitbookHost}`)) {
+        return true;
+    }
+
+    return false;
+}
+
+/**
+ * Check if the URL is a GitBook assets host URL.
+ */
+export function isGitBookAssetsHostURL(input: URL | string): boolean {
+    const url = typeof input === 'string' ? new URL(input) : input;
+
+    if (!GITBOOK_ASSETS_URL) {
+        return false;
+    }
+
+    const gitbookAssetsHost = new URL(GITBOOK_ASSETS_URL).host;
+
+    if (url.host === gitbookAssetsHost) {
+        return true;
+    }
+
+    return false;
+}

packages/gitbook-v2/src/lib/images/createImageResizer.ts

@@ -1,8 +1,9 @@
 import 'server-only';
 
+import { GITBOOK_IMAGE_RESIZE_SIGNING_KEY, GITBOOK_IMAGE_RESIZE_URL } from '../env';
+import type { GitBookLinker } from '../links';
+import { type SignatureVersion, generateImageSignature } from './signatures';
 import type { ImageResizer } from './types';
-import { generateImageSignature, SignatureVersion } from './signatures';
-import { GitBookSpaceLinker } from '../links';
 
 interface CloudflareImageJsonFormat {
     width: number;
@@ -36,12 +37,16 @@ export function createImageResizer({
     linker,
 }: {
     /** The linker to use to create URLs. */
-    linker: GitBookSpaceLinker;
+    linker: GitBookLinker;
     /** The host name of the current site. */
     host: string;
 }): ImageResizer {
+    if (!GITBOOK_IMAGE_RESIZE_URL || !GITBOOK_IMAGE_RESIZE_SIGNING_KEY) {
+        return createNoopImageResizer();
+    }
+
     return {
-        resize: (urlInput) => {
+        getResizedImageURL: (urlInput) => {
             if (!checkIsSizableImageURL(urlInput)) {
                 return null;
             }
@@ -57,26 +62,27 @@ export function createImageResizer({
                     url: urlInput,
                 });
 
-                const url = new URL(linker.toAbsoluteURL('/~gitbook/image'));
+                const url = linker.toAbsoluteURL(linker.toPathInSite('/~gitbook/image'));
-                url.searchParams.set('url', getImageAPIUrl(urlInput));
+                const searchParams = new URLSearchParams();
+                searchParams.set('url', getImageAPIUrl(urlInput));
 
                 if (options.width) {
-                    url.searchParams.set('width', options.width.toString());
+                    searchParams.set('width', options.width.toString());
                 }
                 if (options.height) {
-                    url.searchParams.set('height', options.height.toString());
+                    searchParams.set('height', options.height.toString());
                 }
                 if (options.dpr) {
-                    url.searchParams.set('dpr', options.dpr.toString());
+                    searchParams.set('dpr', options.dpr.toString());
                 }
                 if (options.quality) {
-                    url.searchParams.set('quality', options.quality.toString());
+                    searchParams.set('quality', options.quality.toString());
                 }
 
-                url.searchParams.set('sign', cachedSignature.signature);
+                searchParams.set('sign', cachedSignature.signature);
-                url.searchParams.set('sv', cachedSignature.version);
+                searchParams.set('sv', cachedSignature.version);
 
-                return url.toString();
+                return `${url}?${searchParams.toString()}`;
             };
         },
 
@@ -95,18 +101,11 @@ export function createImageResizer({
  */
 export function createNoopImageResizer(): ImageResizer {
     return {
-        resize: () => null,
+        getResizedImageURL: () => null,
-        getImageSize: async (input) => null,
+        getImageSize: async (_input) => null,
     };
 }
 
-/**
- * Return true if images resizing is enabled.
- */
-export function isImageResizingEnabled(): boolean {
-    return !!process.env.GITBOOK_IMAGE_RESIZE_SIGNING_KEY;
-}
-
 /**
  * Check if a URL is an HTTP URL.
  */
@@ -149,9 +148,9 @@ export function checkIsSizableImageURL(input: string): boolean {
  */
 export async function getImageSize(
     input: string,
-    defaultSize: Partial<CloudflareImageOptions> = {},
+    defaultSize: Partial<CloudflareImageOptions> = {}
 ): Promise<{ width: number; height: number } | null> {
-    if (!isImageResizingEnabled() || !checkIsSizableImageURL(input)) {
+    if (!checkIsSizableImageURL(input)) {
         return null;
     }
 
@@ -171,12 +170,7 @@ export async function getImageSize(
             width: json.original.width,
             height: json.original.height,
         };
-    } catch (error) {
+    } catch (_error) {
-        console.error(
-            `failed to fetch image size for ${input}: ${
-                (error as Error).stack ?? (error as Error).message ?? error
-            }`,
-        );
         return null;
     }
 }
@@ -188,7 +182,7 @@ export async function resizeImage(
     input: string,
     options: CloudflareImageOptions & {
         signal?: AbortSignal;
-    },
+    }
 ): Promise<Response> {
     const { signal, ...resizeOptions } = options;
 
@@ -203,33 +197,25 @@ export async function resizeImage(
 
     // Since Cloudflare Images options on fetch are not supported on Cloudflare Pages,
     // we need to use the Cloudflare Image Resize API directly.
-    if (process.env.GITBOOK_IMAGE_RESIZE_URL) {
+    if (!GITBOOK_IMAGE_RESIZE_URL) {
-        const response = await fetch(
+        throw new Error('GITBOOK_IMAGE_RESIZE_URL is not set');
-            `${process.env.GITBOOK_IMAGE_RESIZE_URL}${stringifyOptions(
-                resizeOptions,
-            )}/${encodeURIComponent(input)}`,
-            {
-                headers: {
-                    // Pass the `Accept` header, as Cloudflare uses this to validate the format.
-                    Accept:
-                        resizeOptions.format === 'json'
-                            ? 'application/json'
-                            : `image/${resizeOptions.format || 'jpeg'}`,
-                },
-                signal,
-            },
-        );
-
-        return response;
     }
 
-    return fetch(parsed, {
+    return await fetch(
-        // @ts-ignore
+        `${GITBOOK_IMAGE_RESIZE_URL}${stringifyOptions(
-        cf: {
+            resizeOptions
-            image: resizeOptions,
+        )}/${encodeURIComponent(input)}`,
-        },
+        {
-        signal,
+            headers: {
-    });
+                // Pass the `Accept` header, as Cloudflare uses this to validate the format.
+                Accept:
+                    resizeOptions.format === 'json'
+                        ? 'application/json'
+                        : `image/${resizeOptions.format || 'jpeg'}`,
+            },
+            signal,
+        }
+    );
 }
 
 function stringifyOptions(options: CloudflareImageOptions): string {

packages/gitbook-v2/src/lib/images/signatures.ts

@@ -2,6 +2,8 @@ import 'server-only';
 
 import fnv1a from '@sindresorhus/fnv1a';
 import type { MaybePromise } from 'p-map';
+import { assert } from 'ts-essentials';
+import { GITBOOK_IMAGE_RESIZE_SIGNING_KEY } from '../env';
 
 /**
  * GitBook has supported different version of image signing in the past. To maintain backwards
@@ -26,7 +28,7 @@ type SignFn = (input: SignFnInput) => MaybePromise<string>;
  */
 export async function verifyImageSignature(
     input: SignFnInput,
-    { signature, version }: { signature: string; version: SignatureVersion },
+    { signature, version }: { signature: string; version: SignatureVersion }
 ): Promise<boolean> {
     const generator = IMAGE_SIGNATURE_FUNCTIONS[version];
     const generated = await generator(input);
@@ -55,10 +57,11 @@ const fnv1aUtf8Buffer = new Uint8Array(512);
  * The signature is relative to the current site being rendered to avoid serving images from other sites on the same domain.
  */
 const generateSignatureV2: SignFn = async (input) => {
+    assert(GITBOOK_IMAGE_RESIZE_SIGNING_KEY, 'GITBOOK_IMAGE_RESIZE_SIGNING_KEY is not set');
     const all = [
         input.url,
         input.host, // The hostname is used to avoid serving images from other sites on the same domain
-        process.env.GITBOOK_IMAGE_RESIZE_SIGNING_KEY,
+        GITBOOK_IMAGE_RESIZE_SIGNING_KEY,
     ]
         .filter(Boolean)
         .join(':');
@@ -74,7 +77,8 @@ const fnv1aUtf8BufferV1 = new Uint8Array(512);
  * to know that it was the algorithm that was used.
  */
 const generateSignatureV1: SignFn = async (input) => {
-    const all = [input.url, process.env.GITBOOK_IMAGE_RESIZE_SIGNING_KEY].filter(Boolean).join(':');
+    assert(GITBOOK_IMAGE_RESIZE_SIGNING_KEY, 'GITBOOK_IMAGE_RESIZE_SIGNING_KEY is not set');
+    const all = [input.url, GITBOOK_IMAGE_RESIZE_SIGNING_KEY].filter(Boolean).join(':');
     return fnv1a(all, { utf8Buffer: fnv1aUtf8BufferV1 }).toString(16);
 };
 
@@ -84,7 +88,8 @@ const generateSignatureV1: SignFn = async (input) => {
  * but still exist in previously generated and cached content.
  */
 const generateSignatureV0: SignFn = async (input) => {
-    const all = [input.url, process.env.GITBOOK_IMAGE_RESIZE_SIGNING_KEY].filter(Boolean).join(':');
+    assert(GITBOOK_IMAGE_RESIZE_SIGNING_KEY, 'GITBOOK_IMAGE_RESIZE_SIGNING_KEY is not set');
+    const all = [input.url, GITBOOK_IMAGE_RESIZE_SIGNING_KEY].filter(Boolean).join(':');
     const hash = await crypto.subtle.digest('SHA-256', new TextEncoder().encode(all));
 
     // Convert ArrayBuffer to hex string

packages/gitbook-v2/src/lib/images/types.ts

@@ -20,10 +20,10 @@ export type ImageResizer = {
      * @param input - The image URL to resize.
      * @param options - The options to resize the image.
      */
-    resize(input: string): null | ((options: ResizeImageOptions) => Promise<string>);
+    getResizedImageURL(imageURL: string): null | ((options: ResizeImageOptions) => Promise<string>);
 
     /**
      * Get the size of an image.
      */
-    getImageSize(input: string, options: GetImageSizeOptions): Promise<ImageSize | null>;
+    getImageSize(imageURL: string, options: GetImageSizeOptions): Promise<ImageSize | null>;
 };

packages/gitbook-v2/src/lib/images/utils.ts

@@ -1,14 +1,14 @@
-import { ImageResizer, ResizeImageOptions } from './types';
+import type { ImageResizer, ResizeImageOptions } from './types';
 
 /**
  * Quick utility to get a resized image URL.
  */
 export async function getResizedImageURL(
-    resizer: ImageResizer,
+    resizer: ImageResizer | undefined,
     url: string,
-    options: ResizeImageOptions,
+    options: ResizeImageOptions
 ) {
-    const getURL = resizer.resize(url);
+    const getURL = resizer?.getResizedImageURL(url);
     if (!getURL) {
         return url;
     }

packages/gitbook-v2/src/lib/links.test.ts

@@ -0,0 +1,74 @@
+import { describe, expect, it } from 'bun:test';
+import { createLinker } from './links';
+
+const root = createLinker({
+    host: 'docs.company.com',
+    spaceBasePath: '/',
+    siteBasePath: '/',
+});
+
+const variantInSection = createLinker({
+    host: 'docs.company.com',
+    spaceBasePath: '/section/variant',
+    siteBasePath: '/',
+});
+
+const siteGitBookIO = createLinker({
+    host: 'org.gitbook.io',
+    spaceBasePath: '/sitename/variant/',
+    siteBasePath: '/sitename/',
+});
+
+describe('toPathInContent', () => {
+    it('should return the correct path', () => {
+        expect(root.toPathInSpace('some/path')).toBe('/some/path');
+        expect(variantInSection.toPathInSpace('some/path')).toBe('/section/variant/some/path');
+    });
+
+    it('should handle leading slash', () => {
+        expect(root.toPathInSpace('/some/path')).toBe('/some/path');
+        expect(variantInSection.toPathInSpace('/some/path')).toBe('/section/variant/some/path');
+    });
+});
+
+describe('toPathInSite', () => {
+    it('should return the correct path', () => {
+        expect(root.toPathInSite('some/path')).toBe('/some/path');
+        expect(siteGitBookIO.toPathInSite('some/path')).toBe('/sitename/some/path');
+    });
+});
+
+describe('toRelativePathInSite', () => {
+    it('should return the correct path', () => {
+        expect(root.toRelativePathInSite('/some/path')).toBe('some/path');
+        expect(siteGitBookIO.toRelativePathInSite('/sitename/some/path')).toBe('some/path');
+    });
+
+    it('should preserve absolute paths outside of the site', () => {
+        expect(siteGitBookIO.toRelativePathInSite('/outside/some/path')).toBe('/outside/some/path');
+    });
+});
+
+describe('toAbsoluteURL', () => {
+    it('should return the correct path', () => {
+        expect(root.toAbsoluteURL('some/path')).toBe('https://docs.company.com/some/path');
+        expect(variantInSection.toAbsoluteURL('some/path')).toBe(
+            'https://docs.company.com/some/path'
+        );
+    });
+});
+
+describe('toLinkForContent', () => {
+    it('should return the correct path', () => {
+        expect(root.toLinkForContent('https://docs.company.com/some/path')).toBe('/some/path');
+        expect(siteGitBookIO.toLinkForContent('https://org.gitbook.io/sitename/some/path')).toBe(
+            '/sitename/some/path'
+        );
+    });
+
+    it('should preserve an absolute URL if the site is not the same', () => {
+        expect(siteGitBookIO.toLinkForContent('https://org.gitbook.io/anothersite/some/path')).toBe(
+            'https://org.gitbook.io/anothersite/some/path'
+        );
+    });
+});

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

@@ -1,17 +1,39 @@
-import { RevisionPage, RevisionPageDocument, RevisionPageGroup } from '@gitbook/api';
 import { getPagePath } from '@/lib/pages';
+import { withLeadingSlash, withTrailingSlash } from '@/lib/paths';
+import type { RevisionPage, RevisionPageDocument, RevisionPageGroup } from '@gitbook/api';
+import warnOnce from 'warn-once';
 
 /**
  * Generic interface to generate links based on a given context.
+ *
+ * URL levels:
+ *
+ * https://docs.company.com/basename/section/variant/page
+ *
+ * toPathInSpace('some/path') => /basename/section/variant/some/path
+ * toPathInSite('some/path') => /basename/some/path
+ * toPathForPage({ pages, page }) => /basename/section/variant/some/path
+ * toAbsoluteURL('some/path') => https://docs.company.com/some/path
  */
-export interface GitBookSpaceLinker {
+export interface GitBookLinker {
     /**
-     * Generate an absolute path for a relative path in the current space content.
+     * Generate an absolute path for a relative path to the current content.
      */
     toPathInSpace(relativePath: string): string;
 
     /**
-     * Generate an absolute path for a page in the current space.
+     * Generate an absolute path for a relative path to the current site.
+     */
+    toPathInSite(relativePath: string): string;
+
+    /**
+     * Transform an absolute path in a site, to a relative path from the root of the site.
+     */
+    toRelativePathInSite(absolutePath: string): string;
+
+    /**
+     * Generate an absolute path for a page in the current content.
+     * The result should NOT be passed to `toPathInContent`.
      */
     toPathForPage(input: {
         pages: RevisionPage[];
@@ -20,9 +42,14 @@ export interface GitBookSpaceLinker {
     }): string;
 
     /**
-     * Generate an absolute URL for a given path.
+     * Generate an absolute URL for a given path relative to the host of the current content.
      */
     toAbsoluteURL(absolutePath: string): string;
+
+    /**
+     * Generate a link (URL or path) for a GitBook content URL (url of another site)
+     */
+    toLinkForContent(url: string): string;
 }
 
 /**
@@ -32,60 +59,69 @@ export function createLinker(
     /** Where the top of the space is served on */
     servedOn: {
         protocol?: string;
-        host: string;
+        host?: string;
-        pathname: string;
-    },
-): GitBookSpaceLinker {
-    if (servedOn.host.includes('/')) {
-        throw new Error('Host cannot include a slash');
-    }
 
-    const linker: GitBookSpaceLinker = {
+        /** The base path of the space */
+        spaceBasePath: string;
+
+        /** The base path of the site */
+        siteBasePath: string;
+    }
+): GitBookLinker {
+    warnOnce(!servedOn.host, 'No host provided to createLinker. It can lead to issues with links.');
+
+    const siteBasePath = withTrailingSlash(withLeadingSlash(servedOn.siteBasePath));
+    const spaceBasePath = withTrailingSlash(withLeadingSlash(servedOn.spaceBasePath));
+
+    const linker: GitBookLinker = {
         toPathInSpace(relativePath: string): string {
-            return joinPaths(servedOn.pathname, relativePath);
+            return joinPaths(spaceBasePath, relativePath);
+        },
+
+        toPathInSite(relativePath: string): string {
+            return joinPaths(siteBasePath, relativePath);
+        },
+
+        toRelativePathInSite(absolutePath: string): string {
+            const normalizedPath = withLeadingSlash(absolutePath);
+
+            if (!normalizedPath.startsWith(servedOn.siteBasePath)) {
+                return normalizedPath;
+            }
+
+            return normalizedPath.slice(servedOn.siteBasePath.length);
         },
 
         toAbsoluteURL(absolutePath: string): string {
+            if (!servedOn.host) {
+                return absolutePath;
+            }
+
             return `${servedOn.protocol ?? 'https:'}//${joinPaths(servedOn.host, absolutePath)}`;
         },
 
         toPathForPage({ pages, page, anchor }) {
-            return linker.toPathInSpace(getPagePath(pages, page)) + (anchor ? '#' + anchor : '');
+            return linker.toPathInSpace(getPagePath(pages, page)) + (anchor ? `#${anchor}` : '');
+        },
+
+        toLinkForContent(rawURL: string): string {
+            const url = new URL(rawURL);
+
+            // If the link points to a content in the same site, we return an absolute path
+            // instead of a full URL; it makes it possible to use router navigation
+            if (url.hostname === servedOn.host && url.pathname.startsWith(servedOn.siteBasePath)) {
+                return url.pathname;
+            }
+
+            return rawURL;
         },
     };
 
     return linker;
 }
 
-/**
- * Append a prefix to a linker.
- */
-export function appendPrefixToLinker(
-    linker: GitBookSpaceLinker,
-    prefix: string,
-): GitBookSpaceLinker {
-    const linkerWithPrefix: GitBookSpaceLinker = {
-        toPathInSpace(relativePath: string): string {
-            return linker.toPathInSpace(joinPaths(prefix, relativePath));
-        },
-
-        toAbsoluteURL(absolutePath: string): string {
-            return linker.toAbsoluteURL(joinPaths(prefix, absolutePath));
-        },
-
-        toPathForPage({ pages, page, anchor }) {
-            return (
-                linkerWithPrefix.toPathInSpace(getPagePath(pages, page)) +
-                (anchor ? '#' + anchor : '')
-            );
-        },
-    };
-
-    return linkerWithPrefix;
-}
-
 function joinPaths(prefix: string, path: string): string {
-    const prefixPath = prefix.endsWith('/') ? prefix : prefix + '/';
+    const prefixPath = prefix.endsWith('/') ? prefix : `${prefix}/`;
     const suffixPath = path.startsWith('/') ? path.slice(1) : path;
     return prefixPath + suffixPath;
 }

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

@@ -1,14 +1,47 @@
-import { CustomizationThemeMode } from '@gitbook/api';
+import { CustomizationThemeMode, type PublishedSiteContent } from '@gitbook/api';
 import { headers } from 'next/headers';
 
 export enum MiddlewareHeaders {
+    /**
+     * Type of the route (static or dynamic)
+     */
+    RouteType = 'x-gitbook-route-type',
+
+    /**
+     * The URL of the site (without the pathname)
+     */
+    SiteURL = 'x-gitbook-site-url',
+
+    /**
+     * The data associated with the URL.
+     */
+    SiteURLData = 'x-gitbook-site-url-data',
+
+    /**
+     * The mode of the URL (url or url-host)
+     */
     URLMode = 'x-gitbook-url-mode',
+
+    /**
+     * The theme of the page (light or dark)
+     */
     Theme = 'x-gitbook-theme',
+
+    /**
+     * The customization override to apply.
+     */
     Customization = 'x-gitbook-customization',
+
+    /**
+     * The API token used to fetch the content.
+     * This should only be passed for non-site dynamic routes.
+     */
+    APIToken = 'x-gitbook-api-token',
 }
 
 /**
  * Get the URL mode from the middleware headers.
+ * This function should only be called in a server action or a dynamic route.
  */
 export async function getURLModeFromMiddleware(): Promise<'url' | 'url-host'> {
     const headersList = await headers();
@@ -20,8 +53,40 @@ export async function getURLModeFromMiddleware(): Promise<'url' | 'url-host'> {
     return mode as 'url' | 'url-host';
 }
 
+/**
+ * Get the site URL data from the middleware headers.
+ * This function should only be called in a server action or a dynamic route.
+ */
+export async function getSiteURLDataFromMiddleware(): Promise<PublishedSiteContent> {
+    const headersList = await headers();
+    const siteURLData = headersList.get(MiddlewareHeaders.SiteURLData);
+
+    if (!siteURLData) {
+        throw new Error(
+            'Site URL data is not set by the middleware. This should only be called in a server action or a dynamic route.'
+        );
+    }
+
+    return JSON.parse(siteURLData);
+}
+
+/**
+ * Get the URL from the middleware headers.
+ * This function should only be called in a server action or a dynamic route.
+ */
+export async function getSiteURLFromMiddleware(): Promise<string> {
+    const headersList = await headers();
+    const siteURL = headersList.get(MiddlewareHeaders.SiteURL);
+    if (!siteURL) {
+        throw new Error('URL mode is not set by the middleware');
+    }
+
+    return siteURL;
+}
+
 /**
  * For preview, the theme can be set via query string (?theme=light).
+ * This function should only be called in a dynamic route.
  */
 export async function getThemeFromMiddleware() {
     const headersList = await headers();
@@ -34,3 +99,17 @@ export async function getThemeFromMiddleware() {
         ? CustomizationThemeMode.Light
         : CustomizationThemeMode.Dark;
 }
+
+/**
+ * Get the API token from the middleware headers.
+ * This function should only be called in a dynamic route.
+ */
+export async function getAPITokenFromMiddleware(): Promise<string> {
+    const headersList = await headers();
+    const apiToken = headersList.get(MiddlewareHeaders.APIToken);
+    if (!apiToken) {
+        throw new Error('API token is not set by the middleware');
+    }
+
+    return apiToken;
+}

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

@@ -0,0 +1,41 @@
+import crypto from 'node:crypto';
+import { NextResponse } from 'next/server';
+import { GITBOOK_SECRET } from './env';
+
+/**
+ * Verify the signature of the request and call the function with the body.
+ */
+export async function withVerifySignature<T>(
+    request: Request,
+    fn: (body: T) => Promise<NextResponse>
+) {
+    try {
+        const rawBody = await request.text();
+        const body = JSON.parse(rawBody) as T;
+
+        if (GITBOOK_SECRET) {
+            // Retrieve the signature header from the request
+            const incomingSignature = request.headers.get('x-gitbook-signature');
+            if (!incomingSignature) {
+                return NextResponse.json({ error: 'Missing signature header' }, { status: 400 });
+            }
+
+            const computedSignature = crypto
+                .createHmac('sha256', GITBOOK_SECRET)
+                .update(rawBody)
+                .digest('hex');
+
+            // Compare incoming signature to computed signature
+            if (incomingSignature !== computedSignature) {
+                return NextResponse.json({ error: 'Invalid signature' }, { status: 401 });
+            }
+        }
+
+        return await fn(body);
+    } catch (_error) {
+        return NextResponse.json(
+            { error: 'Invalid request or unable to parse JSON' },
+            { status: 400 }
+        );
+    }
+}

packages/gitbook-v2/src/lib/server-actions.ts

@@ -0,0 +1,31 @@
+import { type GitBookBaseContext, fetchSiteContextByURLLookup, getBaseContext } from './context';
+import {
+    getSiteURLDataFromMiddleware,
+    getSiteURLFromMiddleware,
+    getURLModeFromMiddleware,
+} from './middleware';
+
+/**
+ * Get the base context for a server action.
+ * This function should only be called in a server action.
+ */
+export async function getServerActionBaseContext() {
+    const siteURL = await getSiteURLFromMiddleware();
+    const siteURLData = await getSiteURLDataFromMiddleware();
+    const urlMode = await getURLModeFromMiddleware();
+
+    return getBaseContext({
+        siteURL,
+        siteURLData,
+        urlMode,
+    });
+}
+
+/**
+ * Fetch the context for a site in a server action.
+ * The server action is always dynamic and the request is passed through the middleware.
+ */
+export async function fetchServerActionSiteContext(baseContext: GitBookBaseContext) {
+    const siteURLData = await getSiteURLDataFromMiddleware();
+    return fetchSiteContextByURLLookup(baseContext, siteURLData);
+}

packages/gitbook-v2/src/middleware.ts

@@ -1,111 +1,420 @@
-import { NextResponse } from 'next/server';
+import { CustomizationThemeMode } from '@gitbook/api';
 import type { NextRequest } from 'next/server';
-import { GitBookAPIError } from '@gitbook/api';
+import { NextResponse } from 'next/server';
+import rison from 'rison';
 
-import { removeTrailingSlash } from '@/lib/paths';
+import { getContentSecurityPolicy } from '@/lib/csp';
+import { validateSerializedCustomization } from '@/lib/customization';
+import { removeLeadingSlash, removeTrailingSlash } from '@/lib/paths';
+import {
+    type ResponseCookies,
+    getPathScopedCookieName,
+    getResponseCookiesForVisitorAuth,
+    getVisitorToken,
+    normalizeVisitorAuthURL,
+} from '@/lib/visitor-token';
+import { serveResizedImage } from '@/routes/image';
+import {
+    DataFetcherError,
+    getPublishedContentByURL,
+    normalizeURL,
+    throwIfDataError,
+} from '@v2/lib/data';
+import { isGitBookAssetsHostURL, isGitBookHostURL } from '@v2/lib/env';
 import { MiddlewareHeaders } from '@v2/lib/middleware';
-import { getPublishedContentByURL } from '@v2/lib/data';
 
 export const config = {
-    matcher: ['/((?!_next/|_static/|_vercel|[\\w-]+\\.\\w+).*)'],
+    matcher: [
+        '/((?!_next/static|_next/image|~gitbook/static|~gitbook/revalidate|~gitbook/monitoring|~scalar/proxy).*)',
+    ],
 };
 
 type URLWithMode = { url: URL; mode: 'url' | 'url-host' };
 
 export async function middleware(request: NextRequest) {
-    const extracted = extractURL(request);
+    try {
-    if (extracted) {
+        const requestURL = new URL(request.url);
-        return serveSiteByURL(request, extracted);
-    }
 
-    return NextResponse.next();
+        // Redirect to normalize the URL
+        const normalized = normalizeURL(requestURL);
+        if (normalized.toString() !== requestURL.toString()) {
+            return NextResponse.redirect(normalized.toString());
+        }
+
+        for (const handler of [serveSiteRoutes, serveSpacePDFRoutes]) {
+            const result = await handler(requestURL, request);
+            if (result) {
+                return result;
+            }
+        }
+
+        return NextResponse.next();
+    } catch (error) {
+        return serveErrorResponse(error as Error);
+    }
 }
 
 /**
- * Serve site by URL.
+ * Handle request that are targetting the site routes group.
  */
-async function serveSiteByURL(request: NextRequest, urlWithMode: URLWithMode) {
+async function serveSiteRoutes(requestURL: URL, request: NextRequest) {
-    const dynamicHeaders = getDynamicHeaders(request);
+    const match = getSiteURLFromRequest(request);
-    const { url, mode } = urlWithMode;
+    if (!match) {
+        return null;
+    }
 
-    const result = await getPublishedContentByURL({
+    const { url: siteURL, mode } = match;
-        url: url.toString(),
+
-        visitorAuthToken: null,
+    /**
-        redirectOnError: false,
+     * Serve image resizing requests (all requests containing `/~gitbook/image`).
+     * All URLs containing `/~gitbook/image` are rewritten to `/~gitbook/image`
+     * and serve from a single route handler.
+     *
+     * In GitBook v1: image resizing was done at the root of the hostname (docs.company.com/~gitbook/image)
+     * In GitBook v2: image resizing is done at the content level (docs.company.com/section/variant/~gitbook/image)
+     */
+    if (siteURL.pathname.endsWith('/~gitbook/image')) {
+        return await serveResizedImage(request, {
+            host: siteURL.host,
+        });
+    }
+
+    //
+    // Detect and extract the visitor authentication token from the request
+    //
+    // @ts-ignore - request typing
+    const visitorToken = getVisitorToken({
+        cookies: request.cookies.getAll(),
+        url: siteURL,
     });
 
-    if (result.error) {
+    const withAPIToken = async (apiToken: string | null) => {
-        if (result.error instanceof GitBookAPIError) {
+        const siteURLData = await throwIfDataError(
-            return NextResponse.json(
+            getPublishedContentByURL({
-                {
+                url: siteURL.toString(),
-                    error: result.error.message,
+                visitorAuthToken: visitorToken?.token ?? null,
-                },
+                // When the visitor auth token is pulled from the cookie, set redirectOnError when calling getPublishedContentByUrl to allow
-                { status: result.error.code },
+                // redirecting when the token is invalid as we could be dealing with stale token stored in the cookie.
+                // For example when the VA backend signature has changed but the token stored in the cookie is not yet expired.
+                redirectOnError: visitorToken?.source === 'visitor-auth-cookie',
+
+                // Use the API token passed in the request, if any
+                // as it could be used for .preview hostnames
+                apiToken,
+            })
+        );
+        const cookies: ResponseCookies = [];
+
+        //
+        // Handle redirects
+        //
+        if ('redirect' in siteURLData) {
+            // biome-ignore lint/suspicious/noConsole: we want to log the redirect
+            console.log('redirect', siteURLData.redirect);
+            if (siteURLData.target === 'content') {
+                let contentRedirect = new URL(siteURLData.redirect, request.url);
+
+                // For content redirects, we redirect using the /url/:url format
+                // during development and testing in 'url' mode.
+                if (mode === 'url') {
+                    const urlObject = new URL(siteURLData.redirect);
+                    contentRedirect = new URL(
+                        `/url/${urlObject.host}${urlObject.pathname}${urlObject.search}`,
+                        request.url
+                    );
+                }
+
+                // Keep the same search params as the original request
+                // as it might contain a VA token
+                contentRedirect.search = request.nextUrl.search;
+
+                return NextResponse.redirect(contentRedirect);
+            }
+
+            return NextResponse.redirect(siteURLData.redirect);
+        }
+
+        cookies.push(...getResponseCookiesForVisitorAuth(siteURLData.siteBasePath, visitorToken));
+
+        //
+        // Make sure the URL is clean of any va token after a successful lookup
+        // The token is stored in a cookie that is set on the redirect response
+        //
+        const incomingURL = mode === 'url' ? requestURL : siteURL;
+        const requestURLWithoutToken = normalizeVisitorAuthURL(incomingURL);
+        if (
+            requestURLWithoutToken !== incomingURL &&
+            requestURLWithoutToken.toString() !== incomingURL.toString()
+        ) {
+            return writeResponseCookies(
+                NextResponse.redirect(requestURLWithoutToken.toString()),
+                cookies
             );
-        } else {
-            throw result.error;
         }
-    }
 
-    const { data } = result;
+        //
+        // Render and serve the content
+        //
 
-    if ('redirect' in data) {
+        // The route is static, except when using dynamic parameters from query params
-        return NextResponse.redirect(data.redirect);
+        // (customization override, theme, etc)
-    }
+        let routeType: 'dynamic' | 'static' = 'static';
 
-    const requestHeaders = new Headers(request.headers);
+        const requestHeaders = new Headers(request.headers);
-    requestHeaders.set(MiddlewareHeaders.URLMode, mode);
+        requestHeaders.set(MiddlewareHeaders.RouteType, routeType);
-    if (dynamicHeaders) {
+        requestHeaders.set(MiddlewareHeaders.URLMode, mode);
-        for (const [key, value] of Object.entries(dynamicHeaders)) {
+        requestHeaders.set(MiddlewareHeaders.SiteURL, `${siteURL.origin}${siteURLData.basePath}`);
-            requestHeaders.set(key, value);
+        requestHeaders.set(MiddlewareHeaders.SiteURLData, JSON.stringify(siteURLData));
+
+        // Preview of customization/theme
+        const customization = siteURL.searchParams.get('customization');
+        if (customization && validateSerializedCustomization(customization)) {
+            routeType = 'dynamic';
+            requestHeaders.set(MiddlewareHeaders.Customization, customization);
         }
+        const theme = siteURL.searchParams.get('theme');
+        if (theme === CustomizationThemeMode.Dark || theme === CustomizationThemeMode.Light) {
+            routeType = 'dynamic';
+            requestHeaders.set(MiddlewareHeaders.Theme, theme);
+        }
+
+        // We support forcing dynamic routes by setting a `gitbook-dynamic-route` cookie
+        // This is useful for testing dynamic routes.
+        if (request.cookies.has('gitbook-dynamic-route')) {
+            routeType = 'dynamic';
+        }
+
+        // Pass a x-forwarded-host and origin that are equal to ensure Next doesn't block server actions when proxied
+        requestHeaders.set('x-forwarded-host', request.nextUrl.host);
+        requestHeaders.set('origin', request.nextUrl.origin);
+
+        const siteURLWithoutProtocol = `${siteURL.host}${siteURLData.basePath}`;
+        const { pathname, routeType: routeTypeFromPathname } = encodePathInSiteContent(
+            siteURLData.pathname
+        );
+        routeType = routeTypeFromPathname ?? routeType;
+
+        const route = [
+            'sites',
+            routeType,
+            mode,
+            encodeURIComponent(siteURLWithoutProtocol),
+            encodeURIComponent(rison.encode(siteURLData)),
+            pathname,
+        ].join('/');
+
+        console.log(`rewriting ${request.nextUrl.toString()} to ${route}`);
+
+        const rewrittenURL = new URL(`/${route}`, request.nextUrl.toString());
+        const response = NextResponse.rewrite(rewrittenURL, {
+            request: {
+                headers: requestHeaders,
+            },
+        });
+
+        // Add Content Security Policy header
+        response.headers.set('content-security-policy', getContentSecurityPolicy());
+        // Basic security headers
+        response.headers.set('strict-transport-security', 'max-age=31536000');
+        response.headers.set('referrer-policy', 'no-referrer-when-downgrade');
+        response.headers.set('x-content-type-options', 'nosniff');
+        // Debug header
+        response.headers.set('x-gitbook-route-type', routeType);
+        response.headers.set('x-gitbook-route-site', siteURLWithoutProtocol);
+
+        return writeResponseCookies(response, cookies);
+    };
+
+    // For https://preview/<siteURL> requests,
+    if (siteURL.hostname === 'preview') {
+        return serveWithQueryAPIToken(
+            // We scope the API token to the site ID.
+            `${siteURL.hostname}/${requestURL.pathname.slice(1).split('/')[0]}`,
+            request,
+            withAPIToken
+        );
     }
 
-    const route = [
+    return withAPIToken(null);
-        'sites',
-        dynamicHeaders ? 'dynamic' : 'static',
-        mode,
-        encodeURIComponent(url.host + data.basePath),
-        encodeURIComponent(removeTrailingSlash(data.pathname) || '/'),
-    ].join('/');
-
-    return NextResponse.rewrite(new URL('/' + route, request.url), {
-        headers: requestHeaders,
-    });
 }
 
 /**
- * The URL of the GitBook content can be passed in 2 different ways:
+ * Serve routes for PDF export for a space: /~space/:spaceId/~gitbook/pdf
- * - Hostname is in the `X-GitBook-Host` header and the pathname is the path in the request URL.
- * - The request URL is matching `/url/:url`
  */
-function extractURL(request: NextRequest): URLWithMode | null {
+async function serveSpacePDFRoutes(requestURL: URL, request: NextRequest) {
-    const xGitbookHost = request.headers.get('x-gitbook-host');
+    const pathnameParts = requestURL.pathname.slice(1).split('/');
-    if (xGitbookHost) {
+    if (pathnameParts[0] !== '~space' && pathnameParts[0] !== '~site') {
+        return null;
+    }
+
+    return serveWithQueryAPIToken(
+        pathnameParts.slice(0, 2).join('/'),
+        request,
+        async (apiToken) => {
+            // Handle the rest with the router default logic
+            return NextResponse.next({
+                headers: {
+                    [MiddlewareHeaders.APIToken]: apiToken,
+                },
+            });
+        }
+    );
+}
+
+/**
+ * Serve an error response.
+ */
+function serveErrorResponse(error: Error) {
+    if (error instanceof DataFetcherError) {
+        return new Response(error.message, {
+            status: error.code,
+            headers: { 'content-type': 'text/plain' },
+        });
+    }
+
+    throw error;
+}
+
+/**
+ * Server a response with an API token obtained from the query params.
+ */
+async function serveWithQueryAPIToken(
+    scopePath: string,
+    request: NextRequest,
+    serve: (apiToken: string) => Promise<NextResponse>
+) {
+    // We store the API token in a cookie that is scoped to the specific route
+    // to avoid errors when multiple previews are opened in different tabs.
+    const cookieName = getPathScopedCookieName('gitbook-api-token', scopePath);
+
+    // Extract a potential GitBook API token passed in the request
+    // If found, we redirect to the same URL but with the token in the cookie
+    const queryAPIToken = request.nextUrl.searchParams.get('token');
+    if (queryAPIToken) {
+        request.nextUrl.searchParams.delete('token');
+        return writeResponseCookies(NextResponse.redirect(request.nextUrl.toString()), [
+            {
+                name: cookieName,
+                value: queryAPIToken,
+                options: {
+                    httpOnly: true,
+                    sameSite: process.env.NODE_ENV === 'production' ? 'none' : undefined,
+                    secure: process.env.NODE_ENV === 'production',
+                    maxAge: 60 * 60, // 1 hour
+                },
+            },
+        ]);
+    }
+
+    const apiToken = request.cookies.get(cookieName)?.value;
+    if (!apiToken) {
+        throw new DataFetcherError('Missing API token', 400);
+    }
+
+    return serve(apiToken);
+}
+
+/**
+ * The URL of the GitBook content can be passed in 3 different ways (in order of priority):
+ * - The request has a `X-GitBook-URL` header:
+ *      URL is taken from the header.
+ * - The request has a `X-Forwarded-Host` header:
+ *      Host is taken from the header, pathname is taken from the request URL.
+ * - The request URL is matching `/url/:url`:
+ *      URL is taken from the pathname.
+ */
+function getSiteURLFromRequest(request: NextRequest): URLWithMode | null {
+    const xGitbookUrl = request.headers.get('x-gitbook-url');
+    if (xGitbookUrl) {
         return {
-            url: new URL(`https://${xGitbookHost}${request.nextUrl.pathname}`),
+            url: appendQueryParams(new URL(xGitbookUrl), request.nextUrl.searchParams),
             mode: 'url-host',
         };
     }
 
+    const isMainHost = isGitBookHostURL(request.url);
+    const isAssetsHost = isGitBookAssetsHostURL(request.url);
+
+    // /url/:url requests on the main host
     const prefix = '/url/';
-    if (request.nextUrl.pathname.startsWith(prefix)) {
+    if (isMainHost && request.nextUrl.pathname.startsWith(prefix)) {
         return {
-            url: new URL(`https://${request.nextUrl.pathname.slice(prefix.length)}`),
+            url: appendQueryParams(
+                new URL(`https://${request.nextUrl.pathname.slice(prefix.length)}`),
+                request.nextUrl.searchParams
+            ),
             mode: 'url',
         };
     }
 
+    // Skip other requests to main hosts
+    if (isMainHost || isAssetsHost) {
+        return null;
+    }
+
+    const xForwardedHost = request.headers.get('x-forwarded-host');
+    // The x-forwarded-host is set by Vercel for all requests
+    // so we ignore it if the hostname is the same as the instance one.
+    if (xForwardedHost) {
+        return {
+            url: appendQueryParams(
+                new URL(`https://${xForwardedHost}${request.nextUrl.pathname}`),
+                request.nextUrl.searchParams
+            ),
+            mode: 'url-host',
+        };
+    }
+
     return null;
 }
 
 /**
- * Evaluate if a request is dynamic or static.
+ * Encode path in a site content.
+ * Special paths are not encoded and passed to be handled by the route handlers.
  */
-function getDynamicHeaders(request: NextRequest): null | Record<string, string> {
+function encodePathInSiteContent(rawPathname: string): {
-    // TODO:
+    pathname: string;
-    // - check token in query string
+    routeType?: 'static' | 'dynamic';
-    // - check token in cookies
+} {
-    // - check special headers or query string
+    const pathname = removeLeadingSlash(removeTrailingSlash(rawPathname));
-    return null;
+
+    if (pathname.match(/^~gitbook\/ogimage\/\S+$/)) {
+        return { pathname };
+    }
+
+    switch (pathname) {
+        case '~gitbook/icon':
+        case 'llms.txt':
+        case 'sitemap.xml':
+        case 'sitemap-pages.xml':
+        case 'robots.txt':
+            return { pathname };
+        case '~gitbook/pdf':
+            // PDF routes are always dynamic as they depend on the search params.
+            return { pathname, routeType: 'dynamic' };
+        default:
+            return { pathname: encodeURIComponent(pathname || '/') };
+    }
+}
+
+/**
+ * Append all the query params from a URL to another URL.
+ */
+function appendQueryParams(url: URL, from: URLSearchParams) {
+    for (const [key, value] of from.entries()) {
+        url.searchParams.set(key, value);
+    }
+
+    return url;
+}
+
+/**
+ * Write the cookies to a response.
+ */
+function writeResponseCookies<R extends NextResponse>(response: R, cookies: ResponseCookies): R {
+    cookies.forEach((cookie) => {
+        response.cookies.set(cookie.name, cookie.value, cookie.options);
+    });
+
+    return response;
 }

packages/gitbook-v2/turbo.json

@@ -0,0 +1,11 @@
+{
+    "extends": ["//"],
+    "tasks": {
+        "generate": {
+            "outputs": ["public"]
+        },
+        "typecheck": {
+            "dependsOn": ["^typecheck"]
+        }
+    }
+}

packages/gitbook-v2/wrangler.toml

@@ -1,5 +1,50 @@
 main = ".open-next/worker.js"
-name = "gitbook-v2"
+name = "gitbook-open-v2"
-compatibility_date = "2024-09-23"
+compatibility_date = "2025-03-11"
-compatibility_flags = ["nodejs_compat"]
+compatibility_flags = ["nodejs_compat", "allow_importable_env"]
 assets = { directory = ".open-next/assets", binding = "ASSETS" }
+observability = { enabled = true }
+
+[env.preview]
+kv_namespaces = [
+  { binding = "NEXT_CACHE_WORKERS_KV", id = "b7dd9cf58bf2458f84812a2d83b3760c" } # gitbook-open-v2-cache-preview
+]
+d1_databases = [
+  { binding = "NEXT_CACHE_D1", database_id = "f59ddb40-ad72-4312-9395-0ac6a129af8e", database_name = "gitbook-open-v2-tags-preview" }
+]
+services = [
+  { binding = "NEXT_CACHE_REVALIDATION_WORKER", service = "gitbook-open-v2-preview" },
+  { binding = "GITBOOK_API", service = "gitbook-x-prod-api-cache" }
+]
+
+[env.staging]
+routes = [
+  { pattern = "open-2c.gitbook-staging.com/*", zone_name = "gitbook-staging.com" },
+  { pattern = "static-2c.gitbook-staging.com/*", zone_name = "gitbook-staging.com" }
+]
+kv_namespaces = [
+  { binding = "NEXT_CACHE_WORKERS_KV", id = "a446e25f12b741afb185f1e5b4474f0a" } # gitbook-open-v2-cache-staging
+]
+d1_databases = [
+  { binding = "NEXT_CACHE_D1", database_id = "9df62e39-1f35-4066-83aa-e9b8ed3ac8d5", database_name = "gitbook-open-v2-tags-staging" }
+]
+services = [
+  { binding = "NEXT_CACHE_REVALIDATION_WORKER", service = "gitbook-open-v2-staging" },
+  { binding = "GITBOOK_API", service = "gitbook-x-staging-api-cache" }
+]
+
+[env.production]
+routes = [
+  { pattern = "open-2c.gitbook.com/*", zone_name = "gitbook.com" },
+  { pattern = "static-2c.gitbook.com/*", zone_name = "gitbook.com" }
+]
+kv_namespaces = [
+  { binding = "NEXT_CACHE_WORKERS_KV", id = "72379746280d4e79acf24440eea950dc" } # gitbook-open-v2-cache-production
+]
+d1_databases = [
+  { binding = "NEXT_CACHE_D1", database_id = "a6f16fce-5f45-43a9-89a4-7b83ddf25b77", database_name = "gitbook-open-v2-tags-production" }
+]
+services = [
+  { binding = "NEXT_CACHE_REVALIDATION_WORKER", service = "gitbook-open-v2-production" },
+  { binding = "GITBOOK_API", service = "gitbook-x-prod-api-cache" }
+]

packages/gitbook/.env.example

@@ -23,8 +23,5 @@
 ## Caching
 # GITBOOK_OUTPUT_CACHE=true
 
-### Sentry ###
-# SENTRY_DSN=xxx
-
 ### Silent logs
 # SILENT=true

packages/gitbook/.eslintrc.json

@@ -1,31 +0,0 @@
-{
-    "extends": "next/core-web-vitals",
-    "plugins": ["import"],
-    "rules": {
-        "import/order": [
-            "error",
-            {
-                "groups": ["builtin", "external", ["internal", "parent", "sibling", "index"]],
-                "newlines-between": "always",
-                "distinctGroup": true,
-                "pathGroups": [
-                    {
-                        "pattern": "@/**",
-                        "group": "external",
-                        "position": "after"
-                    },
-                    {
-                        "pattern": "@gitbook/**",
-                        "group": "external",
-                        "position": "after"
-                    }
-                ],
-                "alphabetize": {
-                    "order": "asc",
-                    "caseInsensitive": true
-                }
-            }
-        ],
-        "@next/next/no-img-element": ["off"]
-    }
-}

packages/gitbook/.gitignore

@@ -23,9 +23,6 @@ next-env.d.ts
 # visual tests
 screenshots/
 
-# Sentry Config File
-.sentryclirc
-
 /test-results/
 /playwright-report/
 /blob-report/

packages/gitbook/CHANGELOG.md

@@ -1,390 +1,520 @@
 # gitbook
 
+## 0.8.2
+
+### Patch Changes
+
+- ed07206: Fix OpenAPI path overflow on mobile
+- 4dab1c5: Fix alignment of `prominent` search bar on full-width pages
+- 6eae764: Support body examples
+- 54ee014: Add initial support for loading custom fonts
+- d2facb2: Mark properties as optional if not required
+- bba2e52: Fix site redirects when it includes a section/variant path
+- 4723f03: Restyle section group dropdown
+- 24b7808: Fix `prominent` search bar width on `md` screens
+- 1fe3286: Fix OpenAPI block overflow issue
+- Updated dependencies [48c18c0]
+- Updated dependencies [6eae764]
+- Updated dependencies [7212973]
+- Updated dependencies [d2facb2]
+- Updated dependencies [73e2b47]
+- Updated dependencies [70be2c6]
+- Updated dependencies [fc00b51]
+- Updated dependencies [a84b06b]
+  - @gitbook/openapi-parser@2.1.1
+  - @gitbook/react-openapi@1.1.6
+
+## 0.8.1
+
+### Patch Changes
+
+- 886e204: Update OpenAPI operation path design
+- Updated dependencies [886e204]
+- Updated dependencies [4f0a772]
+  - @gitbook/react-openapi@1.1.5
+  - @gitbook/colors@0.3.0
+
+## 0.8.0
+
+### Minor Changes
+
+- eec3eed: Add styling for prominent search bar option
+
+### Patch Changes
+
+- 16292de: Display sidebar on no-TOC pages
+- 9b5f971: Transparent background for OpenAPI path block
+- 99da8df: Optimize favicons and og:image using the image resizer
+- b011ea0: Fix rendering of code blocks in Ask AI when being streamed
+- 9bc3d50: Info hint background and link color fixes
+- 31d800e: Render OpenAPISchemas block
+- Updated dependencies [6aaeae2]
+- Updated dependencies [c60e9ba]
+- Updated dependencies [9108c56]
+- Updated dependencies [31d800e]
+- Updated dependencies [ff3b708]
+- Updated dependencies [f32bf1f]
+- Updated dependencies [c9ea239]
+  - @gitbook/react-contentkit@0.7.0
+  - @gitbook/react-openapi@1.1.4
+  - @gitbook/cache-tags@0.2.0
+
+## 0.7.3
+
+### Patch Changes
+
+- eaf2d68: OpenAPI operation title fallback in sections
+- Updated dependencies [844059f]
+- Updated dependencies [88f64b0]
+  - @gitbook/react-openapi@1.1.3
+  - @gitbook/icons@0.2.0
+  - @gitbook/react-contentkit@0.6.2
+
+## 0.7.2
+
+### Patch Changes
+
+- f127d28: Rename OpenAPIModels to OpenAPISchemas
+- Updated dependencies [f127d28]
+  - @gitbook/react-openapi@1.1.2
+
+## 0.7.1
+
+### Patch Changes
+
+- Updated dependencies [f574858]
+  - @gitbook/react-openapi@1.1.1
+
+## 0.7.0
+
+### Minor Changes
+
+- bb3ca9c: Implement OpenAPI models blocks
+
+### Patch Changes
+
+- 5907bd9: Adjust hint block spacing
+- 9ffc3b6: Fix content overflowing out of its container in tabs
+- Updated dependencies [0278a14]
+- Updated dependencies [bb3ca9c]
+- Updated dependencies [3173d8e]
+- Updated dependencies [052e07a]
+  - @gitbook/openapi-parser@2.1.0
+  - @gitbook/react-openapi@1.1.0
+
+## 0.6.5
+
+### Patch Changes
+
+- 05ffd0e: Improving data cache management for computed content
+- 8beb5d6: Add input elements to ContentKit
+- Updated dependencies [53f5dbe]
+- Updated dependencies [05ffd0e]
+- Updated dependencies [8beb5d6]
+  - @gitbook/openapi-parser@2.0.2
+  - @gitbook/cache-tags@0.1.0
+  - @gitbook/react-contentkit@0.6.1
+  - @gitbook/react-openapi@1.0.5
+
+## 0.6.4
+
+### Patch Changes
+
+- 9b914d1: Fix getProxyModeBasePath that was computing incorrect base path in some scenarios
+- 2ae76f9: Change how a site in proxy mode is resolved
+- 027a859: Add support for links style customization option
+- 3e11678: fix: lost section groups
+- 3319375: Support OpenAPI operation block
+- Updated dependencies [722f02e]
+- Updated dependencies [0924259]
+  - @gitbook/react-openapi@1.0.4
+  - @gitbook/openapi-parser@2.0.1
+
 ## 0.6.3
 
 ### Patch Changes
 
--   a820739: Remove unused search api method from gitbook/api/lib
+- a820739: Remove unused search api method from gitbook/api/lib
--   a054554: Implement a trusted mode to speed up OpenAPI spec validation
+- a054554: Implement a trusted mode to speed up OpenAPI spec validation
--   66d0fc0: Update design for hint block: use semantic colors (info, warning, danger, success) and add alternative styling for hints with headings
+- 66d0fc0: Update design for hint block: use semantic colors (info, warning, danger, success) and add alternative styling for hints with headings
--   9f0de74: Add support for new OpenAPI ref
+- 9f0de74: Add support for new OpenAPI ref
--   da55fac: Render GitBook blocks in OpenAPI operation description
+- da55fac: Render GitBook blocks in OpenAPI operation description
--   Updated dependencies [c808bb1]
+- Updated dependencies [c808bb1]
--   Updated dependencies [dc2dbc5]
+- Updated dependencies [dc2dbc5]
--   Updated dependencies [f1d1d2f]
+- Updated dependencies [f1d1d2f]
--   Updated dependencies [e24206e]
+- Updated dependencies [e24206e]
--   Updated dependencies [a054554]
+- Updated dependencies [a054554]
--   Updated dependencies [05e1d8c]
+- Updated dependencies [05e1d8c]
--   Updated dependencies [b4a12d6]
+- Updated dependencies [b4a12d6]
--   Updated dependencies [9f0de74]
+- Updated dependencies [9f0de74]
--   Updated dependencies [da55fac]
+- Updated dependencies [da55fac]
-    -   @gitbook/openapi-parser@2.0.0
+  - @gitbook/openapi-parser@2.0.0
-    -   @gitbook/react-openapi@1.0.3
+  - @gitbook/react-openapi@1.0.3
 
 ## 0.6.2
 
 ### Patch Changes
 
--   359bb97: Fix opening external links when the GitBook page is embedded in an iframe
+- 359bb97: Fix opening external links when the GitBook page is embedded in an iframe
--   6157583: Improve Markdown parsing
+- 6157583: Improve Markdown parsing
--   82cd9f2: Add support for anchor links in OpenAPI blocks
+- 82cd9f2: Add support for anchor links in OpenAPI blocks
--   Updated dependencies [445baaa]
+- Updated dependencies [445baaa]
--   Updated dependencies [bb5c6a4]
+- Updated dependencies [bb5c6a4]
--   Updated dependencies [a3f1fea]
+- Updated dependencies [a3f1fea]
--   Updated dependencies [6157583]
+- Updated dependencies [6157583]
--   Updated dependencies [7419ee7]
+- Updated dependencies [7419ee7]
--   Updated dependencies [82cd9f2]
+- Updated dependencies [82cd9f2]
-    -   @gitbook/colors@0.2.0
+  - @gitbook/colors@0.2.0
-    -   @gitbook/react-openapi@1.0.2
+  - @gitbook/react-openapi@1.0.2
-    -   @gitbook/openapi-parser@1.0.1
+  - @gitbook/openapi-parser@1.0.1
 
 ## 0.6.1
 
 ### Patch Changes
 
--   dddb4ec: Fix long tab group description
+- dddb4ec: Fix long tab group description
--   Updated dependencies [f8d4c76]
+- Updated dependencies [f8d4c76]
--   Updated dependencies [dddb4ec]
+- Updated dependencies [dddb4ec]
--   Updated dependencies [f8d4c76]
+- Updated dependencies [f8d4c76]
-    -   @gitbook/react-openapi@1.0.1
+  - @gitbook/react-openapi@1.0.1
 
 ## 0.6.0
 
 ### Minor Changes
 
--   98245e5: Adapt code to pull token from customer backend generated custom cookies
+- 98245e5: Adapt code to pull token from customer backend generated custom cookies
--   af3c6a9: Reintroduce a safety check around search whilst we continue investigating caching.
+- af3c6a9: Reintroduce a safety check around search whilst we continue investigating caching.
--   95f2aa4: Track new events for site insights when ads are being clicked
+- 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.
+- 08acea6: Investigate an issue causing caches to return empty objects instead of null/undefined.
--   1138d59: Add support for sidebar background styles
+- 1138d59: Add support for sidebar background styles
--   9e18ae6: Overhaul colour scale & Tailwind colour classes
+- 9e18ae6: Overhaul colour scale & Tailwind colour classes
--   e86e51f: Fix an issue where the redirects of potentially malicious images were not going through.
+- 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.
+- 7059c2b: Add support for computed content by fetching computed documents for pages.
--   c71d159: Track events for site insights using the new dedicated API.
+- c71d159: Track events for site insights using the new dedicated API.
--   eb7c22f: Revert scalar to 1.0.87 to mitigate an issue with ApiClientModalProvider
+- 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
+- ea1468c: Send redirectOnError param to getPublishedContent when token is pulled from cookie
--   7ee9158: Restyle PageAside to use sidebar list styles
+- 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.
+- 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.
+- 1417279: Track clicks on links (header, footer, content) for site insights.
--   9eca010: Improve the display of recommended questions by streaming them.
+- 9eca010: Improve the display of recommended questions by streaming them.
--   160fca1: new OpenAPI blocks design
+- 160fca1: new OpenAPI blocks design
--   71688a8: Introduction of new themes: Clean, Muted, Bold, and Gradient
+- 71688a8: Introduction of new themes: Clean, Muted, Bold, and Gradient
--   1823101: Fix internal properties appearing in OpenAPI docs.
+- 1823101: Fix internal properties appearing in OpenAPI docs.
--   6a073e1: Add antialiasing for text rendering
+- 6a073e1: Add antialiasing for text rendering
--   8126a83: Improve readability of tables with hover style and vertical dividers
+- 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.
+- 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.
+- 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.
+- 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
+- d876399: Fix UI search without ask AI enabled and fix error with questions not returned from API
--   c30bc24: Fix empty sitemap
+- c30bc24: Fix empty sitemap
--   e90c96f: page outline on the right remains visible when scrolling, move mode toggler to PageAside
+- e90c96f: page outline on the right remains visible when scrolling, move mode toggler to PageAside
--   5b4e710: Support llms.txt
+- 5b4e710: Support llms.txt
--   b6c3870: Add support for keyboard marks
+- b6c3870: Add support for keyboard marks
--   6059efe: Fix search no results error showing while there are results
+- 6059efe: Fix search no results error showing while there are results
--   c77142a: Log component stack in Sentry
+- c77142a: Log component stack in Sentry
--   1de9d1a: Apply antialiasing on any text that are not code inline/blocks to avoid contrast issues
+- 1de9d1a: Apply antialiasing on any text that are not code inline/blocks to avoid contrast issues
--   32aa1f9: Handle security issue with cookies on Safari
+- 32aa1f9: Handle security issue with cookies on Safari
--   d935fb1: Don't add extra page scroll when footer is not present
+- d935fb1: Don't add extra page scroll when footer is not present
--   53de5b1: Fix site section URL resolution in Ask AI sources
+- 53de5b1: Fix site section URL resolution in Ask AI sources
--   24f5249: Fix vertical section overflow color
+- 24f5249: Fix vertical section overflow color
--   1762f85: Reduce gap between subsequent header buttons
+- 1762f85: Reduce gap between subsequent header buttons
--   c1e27cc: Fix pass Sentry release properly
+- c1e27cc: Fix pass Sentry release properly
--   5ae1b88: Fix shrinking page icons
+- 5ae1b88: Fix shrinking page icons
--   8f046a9: Start using tint in more places, TOC and PageAside
+- 8f046a9: Start using tint in more places, TOC and PageAside
--   665b6be: Ignore invalid API calls to `getSiteRedirectFromSource` API
+- 665b6be: Ignore invalid API calls to `getSiteRedirectFromSource` API
 
-    To reduce the load on the API and also avoid errors.
+  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
+- 26e6401: Remove KV cache backend and only rely on DO as an external cache backend
--   8cfa67c: Fix default outline list styling
+- 8cfa67c: Fix default outline list styling
--   d66c184: Ignore errors from event flushing
+- d66c184: Ignore errors from event flushing
--   6088fa5: Simplify search results logic to investigate a bug
+- 6088fa5: Simplify search results logic to investigate a bug
--   68287d3: Cache API spec for 24 hours, revalidated every 2 hours
+- 68287d3: Cache API spec for 24 hours, revalidated every 2 hours
--   09c7c30: Try to fix error on og image generation
+- 09c7c30: Try to fix error on og image generation
--   ae99f87: Improve emoji setup, align with GitBook app
+- ae99f87: Improve emoji setup, align with GitBook app
--   2906e60: Downgrade to Next.js v14 to fix incompatibilities with next-on-pages causing multiple bugs.
+- 2906e60: Downgrade to Next.js v14 to fix incompatibilities with next-on-pages causing multiple bugs.
--   3a7210d: Fix zoom image view transition on Safari
+- 3a7210d: Fix zoom image view transition on Safari
--   718a8a5: Position the variant picker in the ToC
+- 718a8a5: Position the variant picker in the ToC
--   e5dc05e: Update footer styling and allow for more than 4 footer groups
+- e5dc05e: Update footer styling and allow for more than 4 footer groups
--   8276ba0: Make cookies access safer
+- 8276ba0: Make cookies access safer
--   1b8a456: Fix Image blocks zoomable behaviour
+- 1b8a456: Fix Image blocks zoomable behaviour
--   56c52e0: Handle Firefox security error on localStorage
+- 56c52e0: Handle Firefox security error on localStorage
--   0510b6f: Add section description to SectionGroupTile
+- 0510b6f: Add section description to SectionGroupTile
--   1fcc807: Fix errors from customization not found
+- 1fcc807: Fix errors from customization not found
--   46edde9: Improve the OpenAPI package API
+- 46edde9: Improve the OpenAPI package API
--   8af1abc: Improve contrast of search box placeholder
+- 8af1abc: Improve contrast of search box placeholder
--   92b7668: Improve header offset
+- 92b7668: Improve header offset
--   d9c8d57: Do not dereference before caching OpenAPI spec.
+- d9c8d57: Do not dereference before caching OpenAPI spec.
--   94876e3: Fix regression issue with page icons for multi-line titles
+- 94876e3: Fix regression issue with page icons for multi-line titles
--   47971dc: Fix OG image generation for non-latin characters
+- 47971dc: Fix OG image generation for non-latin characters
--   82dc9c4: Simplify the `useHash` algo used.
+- 82dc9c4: Simplify the `useHash` algo used.
--   128ad20: Ignore cache invalidation error from local backend
+- 128ad20: Ignore cache invalidation error from local backend
--   ff05e20: Improvements to inline images in headings
+- 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.
+- 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
+- d5aaccd: Remove use of deprecatd API createSitesPageFeedback
--   48ab59f: Improve colour contrast of list item decoration
+- 48ab59f: Improve colour contrast of list item decoration
--   d2bc567: Set Sentry release
+- d2bc567: Set Sentry release
--   37d13d8: Avoid error on fetch by passing a string URL
+- 37d13d8: Avoid error on fetch by passing a string URL
--   d3e573c: Generate sitemap for all sections and spaces
+- d3e573c: Generate sitemap for all sections and spaces
--   f7b801b: Add feedback form to page rating control
+- f7b801b: Add feedback form to page rating control
--   d370a3f: Update the routes for changes/revisions in multi-id mode to match the normal mode
+- d370a3f: Update the routes for changes/revisions in multi-id mode to match the normal mode
--   46f63cb: Fix code format overriding inline link styles
+- 46f63cb: Fix code format overriding inline link styles
--   5950657: Fix emojis display
+- 5950657: Fix emojis display
--   528a053: Fix server actions stability leading to no results found sometimes on search
+- 528a053: Fix server actions stability leading to no results found sometimes on search
--   eac1314: Lazy load iframely script to make page more responsive
+- 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
+- ad19060: Cards stand out slighly more on tinted and dark mode sites, and have better support for headings inside them
--   6f54826: New highlight colors
+- 6f54826: New highlight colors
--   5c87ec7: Implement a safer way to interact with localStorage.
+- 5c87ec7: Implement a safer way to interact with localStorage.
 
-    If it's disabled on the browser it should not throw error.
+  If it's disabled on the browser it should not throw error.
 
--   02d876e: Fix search UI behaviour
+- 02d876e: Fix search UI behaviour
--   f4a90de: Fix two issues where pages would crash due Recoil not behaving correctly in RSC.
+- 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
+- 5576906: Fix table of content displaying arrow next to page with only hidden pages
--   aaab157: Visual fix for section group in Safari
+- aaab157: Visual fix for section group in Safari
--   cbe6139: Fix dynamic tabs infinite loop
+- cbe6139: Fix dynamic tabs infinite loop
--   65cc4af: Fix error when accessing a change request not found
+- 65cc4af: Fix error when accessing a change request not found
--   727bde2: Improve and split OpenAPI parser into its own package
+- 727bde2: Improve and split OpenAPI parser into its own package
--   0b6ddca: Fix variant selector contrast for non-default themes
+- 0b6ddca: Fix variant selector contrast for non-default themes
--   87b8ea8: Fix issue leading to increase the storage write and the stability of the platform
+- 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
+- fde32e2: Force route handler to be dynamic to avoid errors
--   a025118: Change card layout depending on cover aspect ratio
+- a025118: Change card layout depending on cover aspect ratio
--   300f7bf: Fix search loading state
+- 300f7bf: Fix search loading state
--   29d5979: Disable C/C++ highlight temporarily
+- 29d5979: Disable C/C++ highlight temporarily
--   18953b2: Subtler tint color when based on the primary color, by mixing in some gray
+- 18953b2: Subtler tint color when based on the primary color, by mixing in some gray
--   1c97536: Fix Sentry instrumentation
+- 1c97536: Fix Sentry instrumentation
--   b0bd871: Even safer localStorage
+- b0bd871: Even safer localStorage
--   b950a64: Avoid errors on legacy browsers
+- b950a64: Avoid errors on legacy browsers
--   38061bd: Add section groups to section tabs
+- 38061bd: Add section groups to section tabs
--   160fca1: Support deprecated and x-deprecated-sunset in OpenAPI spec
+- 160fca1: Support deprecated and x-deprecated-sunset in OpenAPI spec
--   0e601e2: Improve styling of header buttons with shadows and high-contrast styles
+- 0e601e2: Improve styling of header buttons with shadows and high-contrast styles
--   6691492: Fix viewing PDF from space
+- 6691492: Fix viewing PDF from space
--   e8e64bf: Fix bullet list display on full size blocks
+- e8e64bf: Fix bullet list display on full size blocks
--   16194c5: Vertical orientation for sections list on sites without header
+- 16194c5: Vertical orientation for sections list on sites without header
--   b41d425: Improve OpenAPI rendering performances by caching markdown parsing
+- b41d425: Improve OpenAPI rendering performances by caching markdown parsing
--   1f8e416: Improve performances by highlighting code client-side if the code block is offscreen
+- 1f8e416: Improve performances by highlighting code client-side if the code block is offscreen
--   1429384: Fix error when accessing some not found pages.
+- 1429384: Fix error when accessing some not found pages.
--   21cbd9e: Change link color to primary-subtle
+- 21cbd9e: Change link color to primary-subtle
--   5dab70f: Fix "Parser" language syntax highlighting
+- 5dab70f: Fix "Parser" language syntax highlighting
--   deb8c54: Upgrade Next.js to v15, upgrade Shiki and use JS RegExp engine
+- deb8c54: Upgrade Next.js to v15, upgrade Shiki and use JS RegExp engine
--   56331d2: Fix breadcrumbs emoji display + add contrast styles
+- 56331d2: Fix breadcrumbs emoji display + add contrast styles
--   a6f6591: Fix server actions cache compromised. Leading to some bugs on frontend.
+- a6f6591: Fix server actions cache compromised. Leading to some bugs on frontend.
--   44a20fe: Improve smoothness of scroll listener
+- 44a20fe: Improve smoothness of scroll listener
--   5664e5a: Fix variant dropdown styling in header
+- 5664e5a: Fix variant dropdown styling in header
--   6b50360: Fix view transition error on Safari
+- 6b50360: Fix view transition error on Safari
--   741dd49: Bump `heading-3` font size to offset it from paragraphs
+- 741dd49: Bump `heading-3` font size to offset it from paragraphs
--   5112e3e: Fix Sentry instrumentation server-side
+- 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.
+- 1de338c: Remove animation on section tabs. Page is reloaded (for technical reasons), so the animation is not accurate here.
--   Updated dependencies [d9029c7]
+- Updated dependencies [d9029c7]
--   Updated dependencies [6e54a06]
+- Updated dependencies [6e54a06]
--   Updated dependencies [162b4b7]
+- Updated dependencies [162b4b7]
--   Updated dependencies [e4e2f52]
+- Updated dependencies [e4e2f52]
--   Updated dependencies [0c03676]
+- Updated dependencies [0c03676]
--   Updated dependencies [3e5e458]
+- Updated dependencies [3e5e458]
--   Updated dependencies [46edde9]
+- Updated dependencies [46edde9]
--   Updated dependencies [d9c8d57]
+- Updated dependencies [d9c8d57]
--   Updated dependencies [ccf2cff]
+- Updated dependencies [ccf2cff]
--   Updated dependencies [dda0cc6]
+- Updated dependencies [dda0cc6]
--   Updated dependencies [eb7c22f]
+- Updated dependencies [eb7c22f]
--   Updated dependencies [ea1468c]
+- Updated dependencies [ea1468c]
--   Updated dependencies [648f0e9]
+- Updated dependencies [648f0e9]
--   Updated dependencies [160fca1]
+- Updated dependencies [160fca1]
--   Updated dependencies [f92e906]
+- Updated dependencies [f92e906]
--   Updated dependencies [e721f17]
+- Updated dependencies [e721f17]
--   Updated dependencies [727bde2]
+- Updated dependencies [727bde2]
--   Updated dependencies [dff08ae]
+- Updated dependencies [dff08ae]
--   Updated dependencies [fc7b16f]
+- Updated dependencies [fc7b16f]
--   Updated dependencies [fe8acc9]
+- Updated dependencies [fe8acc9]
--   Updated dependencies [1823101]
+- Updated dependencies [1823101]
--   Updated dependencies [a652958]
+- Updated dependencies [a652958]
--   Updated dependencies [2f73db7]
+- Updated dependencies [2f73db7]
--   Updated dependencies [160fca1]
+- Updated dependencies [160fca1]
--   Updated dependencies [12c7862]
+- Updated dependencies [12c7862]
--   Updated dependencies [b41d425]
+- Updated dependencies [b41d425]
-    -   @gitbook/react-openapi@1.0.0
+  - @gitbook/react-openapi@1.0.0
-    -   @gitbook/openapi-parser@1.0.0
+  - @gitbook/openapi-parser@1.0.0
-    -   @gitbook/react-contentkit@0.6.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.
+- 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.
+- 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.
+- 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.
+- 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.
+- d843e5e: Fix an issue where the space dropdown could appear behind the header.
--   a2e5647: Fix the styling of site section tabs on smaller screens.
+- a2e5647: Fix the styling of site section tabs on smaller screens.
 
 ### Patch Changes
 
--   076dc48: Fix expandable block anchore resolution
+- 076dc48: Fix expandable block anchore resolution
--   d9bb9f9: Fix an issue with the cookie banner buttons being non responsive
+- 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
+- 23584c9: Update the site header with new styling, a new search button, and refactored layout
--   664debc: Add support for tint color
+- 664debc: Add support for tint color
--   4d56f11: Update styling of search+ask modal
+- 4d56f11: Update styling of search+ask modal
--   061c0c1: Fix a regression in variant drop-down caused by missing z-index.
+- 061c0c1: Fix a regression in variant drop-down caused by missing z-index.
--   2f76712: Add breadcrumbs above page title
+- 2f76712: Add breadcrumbs above page title
--   07cf835: Add scroll margin to the top when there are sections
+- 07cf835: Add scroll margin to the top when there are sections
--   5d72b35: Smoother tab transition for sections
+- 5d72b35: Smoother tab transition for sections
--   7c71363: Don't adjust fallback font for mono font.
+- 7c71363: Don't adjust fallback font for mono font.
--   7675c2c: Optimize performances by using new API endpoint for fetching site data.
+- 7675c2c: Optimize performances by using new API endpoint for fetching site data.
--   87eea73: Fix margin and image resolution of header logo
+- 87eea73: Fix margin and image resolution of header logo
--   aa2ed0f: Restyle hint blocks
+- aa2ed0f: Restyle hint blocks
--   ffd3937: Fix security issue with image resizing that could be used for phishing
+- ffd3937: Fix security issue with image resizing that could be used for phishing
--   2ce59d7: Fix - whitespace added to site section tabs with icons.
+- 2ce59d7: Fix - whitespace added to site section tabs with icons.
--   c73e07d: Increase token max length to fix code not highlighted
+- c73e07d: Increase token max length to fix code not highlighted
--   3b3d6e2: Add icons to sections
+- 3b3d6e2: Add icons to sections
--   1ed18c0: style: adds missing scalar css variables
+- 1ed18c0: style: adds missing scalar css variables
--   Updated dependencies [b7a5106]
+- Updated dependencies [b7a5106]
--   Updated dependencies [4771c78]
+- Updated dependencies [4771c78]
--   Updated dependencies [ff50ac2]
+- Updated dependencies [ff50ac2]
--   Updated dependencies [867481c]
+- Updated dependencies [867481c]
--   Updated dependencies [7ba67fd]
+- Updated dependencies [7ba67fd]
--   Updated dependencies [a78c1ec]
+- Updated dependencies [a78c1ec]
-    -   @gitbook/cache-do@0.1.1
+  - @gitbook/cache-do@0.1.1
-    -   @gitbook/react-openapi@0.7.1
+  - @gitbook/react-openapi@0.7.1
 
 ## 0.4.0
 
 ### Minor Changes
 
--   e09f747: Revalidate change request cached content when pressing refresh button
+- e09f747: Revalidate change request cached content when pressing refresh button
--   2fa0851: Add navigation tabs for sections
+- 2fa0851: Add navigation tabs for sections
--   a4b63b8: Support resolution of new site URLs with sections
+- a4b63b8: Support resolution of new site URLs with sections
--   5c35f36: Replace all icons, previously imported from Geist, by new package `@gitbook/icons`
+- 5c35f36: Replace all icons, previously imported from Geist, by new package `@gitbook/icons`
--   e9b31a5: Unify section tab styles with page item styles
+- e9b31a5: Unify section tab styles with page item styles
--   f12a215: Add support for Norwegian language
+- f12a215: Add support for Norwegian language
--   f4c9536: Optimize layout shift while transitioning between pages with full width blocks (ex: OpenAPI blocks)
+- f4c9536: Optimize layout shift while transitioning between pages with full width blocks (ex: OpenAPI blocks)
--   1f24fe4: Add support for page icons
+- 1f24fe4: Add support for page icons
--   cda08a9: Add support for searching results in a sections site
+- cda08a9: Add support for searching results in a sections site
--   b32e40c: Persist state of tabs and dynamically sync them based on title
+- b32e40c: Persist state of tabs and dynamically sync them based on title
--   15d2ee3: Show the caption for file blocks
+- 15d2ee3: Show the caption for file blocks
--   f885e88: Improve the toolbar for change-requests and revisions to show more actions
+- f885e88: Improve the toolbar for change-requests and revisions to show more actions
--   07ea45b: Remove deprecated synced block from GitBook Open
+- 07ea45b: Remove deprecated synced block from GitBook Open
--   c3675fd: Added support for new Reusable Content block.
+- c3675fd: Added support for new Reusable Content block.
--   1f24fe4: Add support for icons style customization for sites
+- 1f24fe4: Add support for icons style customization for sites
--   4c19014: Prevent search indexation for pages where it's configured as disabled
+- 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.
+- 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
+- 1152445: Changed the alternative URL resolution criteria in order to support site URLs without /v/ prefix
--   2c437f7: Fix linking to a tab itself
+- 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
+- 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
+- 51fa3ab: Adds content-visibility css property to OpenAPI Operation for better render performance
--   a7066cc: Fix scroll position when navigating pages on mobile
+- a7066cc: Fix scroll position when navigating pages on mobile
--   c754fc9: Add automatic color contrast in site header, restyle search button
+- c754fc9: Add automatic color contrast in site header, restyle search button
--   5fe7adb: RND-3532: drop down menu for hidden links at small screen size
+- 5fe7adb: RND-3532: drop down menu for hidden links at small screen size
--   6295881: Change dark mode shadow for multi-space search toolbar
+- 6295881: Change dark mode shadow for multi-space search toolbar
--   f89b31c: Upgrade the scalar api client package
+- f89b31c: Upgrade the scalar api client package
--   13c7534: Use ellipsis and fix icon color for more links in the header on small screen
+- 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
+- f885e88: Improve consistency of change request preview by removing cache-control on response
--   16e6171: Improve performances of loading pages with embeds by caching them
+- 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
+- 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
+- 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
+- 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
+- 042b850: Automatically scroll to active item in TOC
--   d43202f: Optimize bundle size of the server output by reducing bundle size of shiki (skipping themes)
+- 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
+- bfbed1a: Ensure "Sponsored via GitBook" can be translated in all languages
--   fe9e6c1: Update ogimage with new design
+- fe9e6c1: Update ogimage with new design
--   17f71ba: Use url hash to open Expandable and scroll to anchor
+- 17f71ba: Use url hash to open Expandable and scroll to anchor
--   3c07e65: Fix margin for paragraphs in quote blocks
+- 3c07e65: Fix margin for paragraphs in quote blocks
--   636b868: Use new cache backend, powered by Durable Objects, alongside the existing ones (KV, etc).
+- 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
+- f16560c: Include offset in calculations of whether scrollable element is in view
--   689f553: Fix inconsistent click area in table because of scroll indicator
+- 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
+- 6ce3cea: Stop using KV cache backend for now, but also improves it for higher performances
--   e914903: Synchronize response and response example tabs
+- e914903: Synchronize response and response example tabs
--   0f990c7: Show definition title when visible in cards
+- 0f990c7: Show definition title when visible in cards
--   e3a3d6a: Fix flickering when displaying an "Ask" answer with code blocks
+- e3a3d6a: Fix flickering when displaying an "Ask" answer with code blocks
--   4cbcc5b: Rollback of scalar modal while fixing perf issue
+- 4cbcc5b: Rollback of scalar modal while fixing perf issue
--   3996110: Optimize images rendered in community ads
+- 3996110: Optimize images rendered in community ads
--   133c3e7: Update design of Checkbox to be more consistent and readable
+- 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
+- 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
+- 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
+- 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`
+- 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
+- cb782a7: Fix "ip" being passed to BSA for community ads
--   a7af3ca: Improving the look and feel of new section tabs
+- a7af3ca: Improving the look and feel of new section tabs
--   0bf985a: Don't show hidden pages in the empty state of a page
+- 0bf985a: Don't show hidden pages in the empty state of a page
--   d6c28a0: Update header styling of sections, variant selector, and button links
+- 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)
+  - Change position of variant selector depending on context (next to logo or in table of contents)
-    -   Update section tab styling and animation
+  - Update section tab styling and animation
-    -   Make header buttons smaller with a new `medium` button size
+  - Make header buttons smaller with a new `medium` button size
 
--   Updated dependencies [51fa3ab]
+- Updated dependencies [51fa3ab]
--   Updated dependencies [9b8d519]
+- Updated dependencies [9b8d519]
--   Updated dependencies [cf3045a]
+- Updated dependencies [cf3045a]
--   Updated dependencies [f89b31c]
+- Updated dependencies [f89b31c]
--   Updated dependencies [d0f4860]
+- Updated dependencies [d0f4860]
--   Updated dependencies [ef9d012]
+- Updated dependencies [ef9d012]
--   Updated dependencies [094e9cd]
+- Updated dependencies [094e9cd]
--   Updated dependencies [636b868]
+- Updated dependencies [636b868]
--   Updated dependencies [56f5fa1]
+- Updated dependencies [56f5fa1]
--   Updated dependencies [5c35f36]
+- Updated dependencies [5c35f36]
--   Updated dependencies [4247361]
+- Updated dependencies [4247361]
--   Updated dependencies [aa8c49e]
+- Updated dependencies [aa8c49e]
--   Updated dependencies [e914903]
+- Updated dependencies [e914903]
--   Updated dependencies [4cbcc5b]
+- Updated dependencies [4cbcc5b]
--   Updated dependencies [0f1565c]
+- Updated dependencies [0f1565c]
--   Updated dependencies [237b703]
+- Updated dependencies [237b703]
--   Updated dependencies [51955da]
+- Updated dependencies [51955da]
--   Updated dependencies [a679e72]
+- Updated dependencies [a679e72]
--   Updated dependencies [c079c3c]
+- Updated dependencies [c079c3c]
--   Updated dependencies [5c35f36]
+- Updated dependencies [5c35f36]
--   Updated dependencies [776bc31]
+- Updated dependencies [776bc31]
-    -   @gitbook/react-openapi@0.7.0
+  - @gitbook/react-openapi@0.7.0
-    -   @gitbook/cache-do@0.1.0
+  - @gitbook/cache-do@0.1.0
-    -   @gitbook/icons@0.1.0
+  - @gitbook/icons@0.1.0
-    -   @gitbook/react-contentkit@0.5.1
+  - @gitbook/react-contentkit@0.5.1
-    -   @gitbook/react-math@0.6.0
+  - @gitbook/react-math@0.6.0
 
 ## 0.3.0
 
 ### Minor Changes
 
--   24b785c: Update shiki for code block syntax highlighting, with support for more languages and fixes for diffs. It also patches the deployment on Cloudflare to support edge functions larger than 4MB.
+- 24b785c: Update shiki for code block syntax highlighting, with support for more languages and fixes for diffs. It also patches the deployment on Cloudflare to support edge functions larger than 4MB.
 
 ### Patch Changes
 
--   acc3f2f: Fix error with the "Try it" of OpenAPI block because of the Scalar proxy failing on Cloudflare with the `cache` option
+- acc3f2f: Fix error with the "Try it" of OpenAPI block because of the Scalar proxy failing on Cloudflare with the `cache` option
--   Updated dependencies [709f1a1]
+- Updated dependencies [709f1a1]
--   Updated dependencies [ede2335]
+- Updated dependencies [ede2335]
--   Updated dependencies [0426312]
+- Updated dependencies [0426312]
-    -   @gitbook/react-openapi@0.6.0
+  - @gitbook/react-openapi@0.6.0
 
 ## 0.2.2
 
 ### Patch Changes
 
--   Updated dependencies [3445db4]
+- Updated dependencies [3445db4]
-    -   @gitbook/react-contentkit@0.5.0
+  - @gitbook/react-contentkit@0.5.0
-    -   @gitbook/react-openapi@0.5.0
+  - @gitbook/react-openapi@0.5.0
-    -   @gitbook/react-math@0.5.0
+  - @gitbook/react-math@0.5.0
 
 ## 0.2.1
 
 ### Patch Changes
 
--   Updated dependencies [24cd72e]
+- Updated dependencies [24cd72e]
-    -   @gitbook/react-contentkit@0.4.0
+  - @gitbook/react-contentkit@0.4.0
-    -   @gitbook/react-math@0.4.0
+  - @gitbook/react-math@0.4.0
-    -   @gitbook/react-openapi@0.4.0
+  - @gitbook/react-openapi@0.4.0
 
 ## 0.2.0
 
 ### Minor Changes
 
--   de747b7: Refactor the repository to be a proper monorepo and publish JS files on NPM instead of TypeScript files.
+- de747b7: Refactor the repository to be a proper monorepo and publish JS files on NPM instead of TypeScript files.
 
 ### Patch Changes
 
--   Updated dependencies [de747b7]
+- Updated dependencies [de747b7]
--   Updated dependencies [de747b7]
+- Updated dependencies [de747b7]
-    -   @gitbook/react-contentkit@0.3.0
+  - @gitbook/react-contentkit@0.3.0
-    -   @gitbook/react-openapi@0.3.0
+  - @gitbook/react-openapi@0.3.0
-    -   @gitbook/react-math@0.3.0
+  - @gitbook/react-math@0.3.0