Version Packages (#2984)

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

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

@@ -1,6 +1,12 @@
 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
@@ -8,44 +14,11 @@ inputs:
     description: 'Cloudflare account ID'
     required: true
   environment:
-    description: 'Environment to deploy to'
+    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
-  NEXT_SERVER_ACTIONS_ENCRYPTION_KEY:
-    description: 'Next server actions encryption key'
-    required: true
-  GITBOOK_URL:
-    description: 'GitBook URL'
-    required: true
-  GITBOOK_SECRET:
-    description: 'GitBook secret'
-    required: true
-  GITBOOK_APP_URL:
-    description: 'GitBook app URL'
-    required: false
-  GITBOOK_API_URL:
-    description: 'GitBook API URL'
-    required: false
-  GITBOOK_INTEGRATIONS_HOST:
-    description: 'GitBook integrations host'
-    required: false
-  GITBOOK_IMAGE_RESIZE_SIGNING_KEY:
-    description: 'GitBook image resize signing key'
-    required: true
-  GITBOOK_IMAGE_RESIZE_URL:
-    description: 'GitBook image resize URL'
-    required: true
-  GITBOOK_ICONS_URL:
-    description: 'GitBook icons URL'
-    required: true
-  GITBOOK_ICONS_TOKEN:
-    description: 'GitBook icons token'
-    required: true
-  GITBOOK_ASSETS_PREFIX:
-    description: 'GitBook assets prefix'
-    required: false
 outputs:
     deployment-url: 
       description: "Deployment URL"
@@ -60,21 +33,26 @@ runs:
           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
         - name: Build worker
           run: bun run turbo build:v2:cloudflare
           shell: bash
-          env:
-            NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: ${{ inputs.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY }}
-            GITBOOK_URL: ${{ inputs.GITBOOK_URL }}
-            GITBOOK_SECRET: ${{ inputs.GITBOOK_SECRET }}
-            GITBOOK_APP_URL: ${{ inputs.GITBOOK_APP_URL }}
-            GITBOOK_API_URL: ${{ inputs.GITBOOK_API_URL }}
-            GITBOOK_INTEGRATIONS_HOST: ${{ inputs.GITBOOK_INTEGRATIONS_HOST }}
-            GITBOOK_IMAGE_RESIZE_SIGNING_KEY: ${{ inputs.GITBOOK_IMAGE_RESIZE_SIGNING_KEY }}
-            GITBOOK_IMAGE_RESIZE_URL: ${{ inputs.GITBOOK_IMAGE_RESIZE_URL }}
-            GITBOOK_ICONS_URL: ${{ inputs.GITBOOK_ICONS_URL }}
-            GITBOOK_ICONS_TOKEN: ${{ inputs.GITBOOK_ICONS_TOKEN }}
-            GITBOOK_ASSETS_PREFIX: ${{ inputs.GITBOOK_ASSETS_PREFIX }}
         - id: deploy
           name: Deploy to Cloudflare
           uses: cloudflare/wrangler-action@v3.14.0
@@ -84,7 +62,7 @@ runs:
               workingDirectory: ./
               wranglerVersion: '3.112.0'
               environment: ${{ inputs.environment }}
-              command: ${{ inputs.deploy && 'deploy' || 'versions upload' }} --config ./packages/gitbook-v2/wrangler.toml
+              command: ${{ fromJSON(inputs.deploy) == true && 'deploy' || 'versions upload' }} --config ./packages/gitbook-v2/wrangler.toml
         - name: Outputs
           shell: bash
           env:

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

@@ -1,15 +1,21 @@
 name: 'Deploy vercel'
 description: 'Deploy GitBook to Vercel'
 inputs:
-  vercel-org:
+  vercelOrg:
     description: 'Vercel organization'
     required: true
-  vercel-project:
+  vercelProject:
     description: 'Vercel project'
     required: true
-  vercel-token:
+  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
@@ -27,31 +33,43 @@ runs:
           shell: bash
           env:
               PUPPETEER_SKIP_DOWNLOAD: 1
-        - name: Sets env vars for environment
-          shell: bash
-          run: |
-              echo "VERCEL_ENVIRONMENT=${{ inputs.environment }}" >> $GITHUB_ENV
         - name: Pull Vercel Environment Information
-          run: bun run vercel pull --yes --environment=$VERCEL_ENVIRONMENT --token=${{ inputs.vercel-token }}
+          run: bun run vercel pull --yes --environment=${{ inputs.environment }} --token=${{ inputs.vercelToken }}
           shell: bash
           env:
-            VERCEL_ORG_ID: ${{ inputs.vercel-org }}
-            VERCEL_PROJECT_ID: ${{ inputs.vercel-project }}
+            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
         - name: Build Project Artifacts
-          run: bun run vercel build --target=$VERCEL_ENVIRONMENT --token=${{ inputs.vercel-token }}
+          run: bun run vercel build --target=${{ inputs.environment }} --token=${{ inputs.vercelToken }}
           shell: bash
           env:
-            VERCEL_ORG_ID: ${{ inputs.vercel-org }}
-            VERCEL_PROJECT_ID: ${{ inputs.vercel-project }}
+            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=$VERCEL_ENVIRONMENT --token=${{ inputs.vercel-token }})
+              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.vercel-org }}
-            VERCEL_PROJECT_ID: ${{ inputs.vercel-project }}
+            VERCEL_ORG_ID: ${{ inputs.vercelOrg }}
+            VERCEL_PROJECT_ID: ${{ inputs.vercelProject }}
         - name: Outputs
           shell: bash
           run: |

.github/workflows/deploy-preview.yaml

@@ -10,6 +10,9 @@ 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
@@ -32,21 +35,11 @@ jobs:
             - name: Sets env vars for production
               if: github.ref == 'refs/heads/main'
               run: |
-                echo "SENTRY_ENVIRONMENT=production" >> $GITHUB_ENV
                 echo "GITBOOK_ASSETS_PREFIX=https://static.gitbook.com" >> $GITHUB_ENV
-            - name: Sets env vars for preview
-              if: github.ref != 'refs/heads/main'
-              run: |
-                  echo "SENTRY_ENVIRONMENT=preview" >> $GITHUB_ENV
             - 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
@@ -63,56 +56,45 @@ jobs:
     deploy-v2-vercel:
         name: Deploy v2 to Vercel (preview)
         runs-on: ubuntu-latest
-        permissions:
-            contents: read
-            deployments: write
-            issues: write
-            pull-requests: write
-            checks: write
-            statuses: write
+        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 ${{ github.ref == 'refs/heads/main' && 'production' || 'preview' }}
+            - name: Deploy to Vercel
               id: deploy
               uses: ./.github/composite/deploy-vercel
               with:
-                  environment: ${{ github.ref == 'refs/heads/main' && 'production' || 'preview' }}
-                  vercel-org: ${{ secrets.VERCEL_ORG_ID }}
-                  vercel-project: ${{ secrets.VERCEL_PROJECT_ID }}
-                  vercel-token: ${{ secrets.VERCEL_TOKEN }}
+                  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
-        permissions:
-            contents: read
-            deployments: write
-            issues: write
-            pull-requests: write
-            checks: write
-            statuses: write
+        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 ${{ github.ref == 'refs/heads/main' && 'production' || 'preview' }}
+            - name: Deploy to Cloudflare
               id: deploy
               uses: ./.github/composite/deploy-cloudflare
               with:
-                  environment: ${{ github.ref == 'refs/heads/main' && 'production' || 'preview' }}
+                  environment: preview
                   deploy: ${{ github.ref == 'refs/heads/main' }}
                   apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
                   accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
-                  NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: ${{ secrets.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY }}
-                  GITBOOK_URL: ${{ github.ref == 'refs/heads/main' && vars.PRODUCTION_2C_GITBOOK_URL || vars.PREVIEW_2C_GITBOOK_URL }}
-                  GITBOOK_IMAGE_RESIZE_SIGNING_KEY: ${{ secrets.PREVIEW_GITBOOK_IMAGE_RESIZE_SIGNING_KEY }}
-                  GITBOOK_IMAGE_RESIZE_URL: ${{ vars.GITBOOK_IMAGE_RESIZE_URL }}
-                  GITBOOK_ICONS_URL: ${{ vars.GITBOOK_ICONS_URL }}
-                  GITBOOK_ICONS_TOKEN: ${{ vars.GITBOOK_ICONS_TOKEN }}
-                  GITBOOK_SECRET: ${{ github.ref == 'refs/heads/main' && secrets.PRODUCTION_GITBOOK_SECRET|| '' }}
+                  opItem: op://gitbook-open/2c-preview
+                  opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
             - name: Outputs
               run: |
                   echo "URL: ${{ steps.deploy.outputs.deployment-url }}"
@@ -198,7 +180,8 @@ jobs:
             - name: Run Playwright tests
               run: bun e2e
               env:
-                  BASE_URL: ${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/
+                  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:
@@ -238,7 +221,8 @@ jobs:
             - name: Run Playwright tests
               run: bun e2e-customers
               env:
-                  BASE_URL: ${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/
+                  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:
@@ -255,7 +239,7 @@ jobs:
               env:
                   PUPPETEER_SKIP_DOWNLOAD: 1
             - name: Run pagespeed tests
-              run: bun ./packages/gitbook/tests/pagespeed-testing.ts $DEPLOYMENT_URL
+              run: bun ./packages/gitbook/tests/pagespeed-testing.ts
               env:
-                  DEPLOYMENT_URL: ${{needs.deploy-v1-cloudflare.outputs.deployment-url}}
+                  BASE_URL: ${{needs.deploy-v1-cloudflare.outputs.deployment-url}}
                   PAGESPEED_API_KEY: ${{ secrets.PAGESPEED_API_KEY }}

.github/workflows/deploy-production.yaml

@@ -9,6 +9,9 @@ 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:
@@ -18,13 +21,18 @@ jobs:
               id: deploy
               uses: ./.github/composite/deploy-vercel
               with:
-                  environment: production
-                  vercel-org: ${{ secrets.VERCEL_ORG_ID }}
-                  vercel-project: ${{ secrets.VERCEL_PROJECT_ID }}
-                  vercel-token: ${{ secrets.VERCEL_TOKEN }}
+                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:
@@ -34,16 +42,12 @@ jobs:
               id: deploy
               uses: ./.github/composite/deploy-cloudflare
               with:
-                  environment: staging
+                  environment: production
+                  deploy: true
                   apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
                   accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
-                  NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: ${{ secrets.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY }}
-                  GITBOOK_URL: ${{ vars.STAGING_2C_GITBOOK_URL }}
-                  GITBOOK_IMAGE_RESIZE_SIGNING_KEY: ${{ secrets.STAGING_GITBOOK_IMAGE_RESIZE_SIGNING_KEY }}
-                  GITBOOK_IMAGE_RESIZE_URL: ${{ vars.GITBOOK_IMAGE_RESIZE_URL }}
-                  GITBOOK_ICONS_URL: ${{ vars.GITBOOK_ICONS_URL }}
-                  GITBOOK_ICONS_TOKEN: ${{ vars.GITBOOK_ICONS_TOKEN }}
-                  GITBOOK_ASSETS_PREFIX: ${{ vars.STAGING_2C_GITBOOK_ASSETS_PREFIX }}
+                  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

@@ -9,6 +9,9 @@ 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:
@@ -18,13 +21,18 @@ jobs:
               id: deploy
               uses: ./.github/composite/deploy-vercel
               with:
-                  environment: staging
-                  vercel-org: ${{ secrets.VERCEL_ORG_ID }}
-                  vercel-project: ${{ secrets.VERCEL_PROJECT_ID }}
-                  vercel-token: ${{ secrets.VERCEL_TOKEN }}
+                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:
@@ -38,17 +46,8 @@ jobs:
                   deploy: true
                   apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
                   accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
-                  NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: ${{ secrets.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY }}
-                  GITBOOK_URL: ${{ vars.STAGING_2C_GITBOOK_URL }}
-                  GITBOOK_SECRET: ${{ secrets.STAGING_GITBOOK_SECRET }}
-                  GITBOOK_APP_URL: https://app.gitbook-staging.com
-                  GITBOOK_API_URL: https://api.gitbook-staging.com
-                  GITBOOK_INTEGRATIONS_HOST: https://integrations.gitbook-staging.com
-                  GITBOOK_IMAGE_RESIZE_SIGNING_KEY: ${{ secrets.STAGING_GITBOOK_IMAGE_RESIZE_SIGNING_KEY }}
-                  GITBOOK_IMAGE_RESIZE_URL: ${{ vars.GITBOOK_IMAGE_RESIZE_URL }}
-                  GITBOOK_ICONS_URL: ${{ vars.GITBOOK_ICONS_URL }}
-                  GITBOOK_ICONS_TOKEN: ${{ vars.GITBOOK_ICONS_TOKEN }}
-                  GITBOOK_ASSETS_PREFIX: ${{ vars.STAGING_2C_GITBOOK_ASSETS_PREFIX }}
+                  opItem: op://gitbook-open/2c-staging
+                  opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
             - name: Outputs
               run: |
                   echo "URL: ${{ steps.deploy.outputs.deployment-url }}"

.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
-}

biome.json

@@ -18,7 +18,9 @@
             "**/.vercel/**/*",
             "**/.cache/**/*",
             "**/.wrangler/**/*",
-            "packages/openapi-parser/src/fixtures/**/*"
+            "packages/openapi-parser/src/fixtures/**/*",
+            "packages/emoji-codepoints/index.ts",
+            "packages/icons/src/data/*.json"
         ]
     },
     "formatter": {

package.json

@@ -11,7 +11,8 @@
     "overrides": {
         "@codemirror/state": "6.4.1",
         "react": "18.3.1",
-        "react-dom": "18.3.1"
+        "react-dom": "18.3.1",
+        "@gitbook/api": "0.99.0"
     },
     "private": true,
     "scripts": {

packages/cache-tags/CHANGELOG.md

@@ -1,7 +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
+- 05ffd0e: Initial version of the package

packages/cache-tags/package.json

@@ -8,9 +8,9 @@
             "default": "./dist/index.js"
         }
     },
-    "version": "0.1.0",
+    "version": "0.2.0",
     "dependencies": {
-        "@gitbook/api": "0.96.1",
+        "@gitbook/api": "*",
         "assert-never": "^1.2.1"
     },
     "devDependencies": {

packages/cache-tags/src/index.ts

@@ -111,6 +111,17 @@ export function getCacheTag(
     }
 }
 
+/**
+ * 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.
  */

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"
     },

packages/colors/src/transformations.ts

@@ -184,6 +184,7 @@ export function colorScale(
     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/gitbook-v2/CHANGELOG.md

@@ -1,27 +1,34 @@
 # gitbook-v2
 
+## 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
+- 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
+- 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
+- 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

@@ -10,16 +10,21 @@ const nextConfig = {
 
     env: {
         BUILD_VERSION: (process.env.GITHUB_SHA ?? '').slice(0, 7),
-        GITBOOK_URL: process.env.GITBOOK_URL,
-        GITBOOK_SECRET: process.env.GITBOOK_SECRET,
+
+        // 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_SIGNING_KEY: process.env.GITBOOK_IMAGE_RESIZE_SIGNING_KEY,
         GITBOOK_IMAGE_RESIZE_URL: process.env.GITBOOK_IMAGE_RESIZE_URL,
-        GITBOOK_ASSETS_PREFIX: process.env.GITBOOK_ASSETS_PREFIX,
         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,
+
+        // 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

packages/gitbook-v2/package.json

@@ -1,12 +1,12 @@
 {
     "name": "gitbook-v2",
-    "version": "0.2.0",
+    "version": "0.2.1",
     "private": true,
     "dependencies": {
         "next": "^15.2.1",
         "react": "^19.0.0",
         "react-dom": "^19.0.0",
-        "@gitbook/api": "0.96.1",
+        "@gitbook/api": "*",
         "@gitbook/cache-tags": "workspace:*",
         "@sindresorhus/fnv1a": "^3.1.0",
         "server-only": "^0.0.1",
@@ -14,7 +14,7 @@
     },
     "devDependencies": {
         "gitbook": "*",
-        "@opennextjs/cloudflare": "https://pkg.pr.new/opennextjs/opennextjs-cloudflare/@opennextjs/cloudflare@40fec7d",
+        "@opennextjs/cloudflare": "^0.5.10",
         "tailwindcss": "^3.4.0",
         "postcss": "^8"
     },
@@ -26,6 +26,7 @@
         "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]/(content)/[pagePath]/page.tsx

@@ -16,7 +16,7 @@ export default async function Page(props: PageProps) {
     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> {
@@ -25,14 +25,12 @@ export async function generateViewport(props: PageProps): Promise<Viewport> {
 }
 
 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 pathname = getPagePathFromParams(params);
 
     return generateSitePageMetadata({
         context,
         pageParams: { pathname },
-        redirectOnFallback: true,
-        fallback: !!searchParams.fallback,
     });
 }

packages/gitbook-v2/src/app/sites/dynamic/[mode]/[siteURL]/~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]/~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/static/[mode]/[siteURL]/[pagePath]/page.tsx

@@ -28,7 +28,7 @@ export default async function Page(props: PageProps) {
         })
     );
 
-    return <SitePage context={context} pageParams={{ pathname }} redirectOnFallback={true} />;
+    return <SitePage context={context} pageParams={{ pathname }} />;
 }
 
 export async function generateViewport(props: PageProps): Promise<Viewport> {
@@ -44,6 +44,5 @@ export async function generateMetadata(props: PageProps): Promise<Metadata> {
     return generateSitePageMetadata({
         context,
         pageParams: { pathname },
-        redirectOnFallback: true,
     });
 }

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

@@ -1,11 +1,16 @@
 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_ICONS_URL,
+    GITBOOK_IMAGE_RESIZE_SIGNING_KEY,
     GITBOOK_INTEGRATIONS_HOST,
+    GITBOOK_SECRET,
     GITBOOK_URL,
     GITBOOK_USER_AGENT,
 } from '@v2/lib/env';
@@ -18,9 +23,16 @@ export async function GET(_req: NextRequest) {
         GITBOOK_URL,
         GITBOOK_APP_URL,
         GITBOOK_API_URL,
+        GITBOOK_API_PUBLIC_URL,
         GITBOOK_ASSETS_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/~space/[spaceId]/pdf.ts

@@ -0,0 +1,57 @@
+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 linker = createLinker({
+        pathname: getPDFRoutePath(params),
+    });
+    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/context.ts

@@ -16,7 +16,7 @@ import type {
 import { type GitBookDataFetcher, createDataFetcher, throwIfDataError } from '@v2/lib/data';
 import { redirect } from 'next/navigation';
 import { assert } from 'ts-essentials';
-import { GITBOOK_API_TOKEN, GITBOOK_API_URL, GITBOOK_URL } from './env';
+import { GITBOOK_URL } from './env';
 import { type ImageResizer, createImageResizer } from './images';
 import { type GitBookSpaceLinker, createLinker } from './links';
 
@@ -113,30 +113,13 @@ export function getBaseContext(input: {
     const urlMode = input.urlMode;
 
     const dataFetcher = createDataFetcher({
-        apiToken: input.apiToken ?? GITBOOK_API_TOKEN,
-        apiEndpoint: GITBOOK_API_URL,
+        apiToken: input.apiToken ?? null,
     });
-    const gitbookURL = GITBOOK_URL ? new URL(GITBOOK_URL) : undefined;
 
-    const linker =
-        urlMode === 'url-host'
-            ? createLinker({
-                  host: url.host,
-                  pathname: url.pathname,
-              })
-            : createLinker({
-                  protocol: gitbookURL?.protocol,
-                  host: gitbookURL?.host,
-                  pathname: `/url/${url.host}${url.pathname}`,
-              });
-
-    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}`;
-        };
-    }
+    const linker = getLinkerForSiteURL({
+        siteURL: url,
+        urlMode,
+    });
 
     const imageResizer = createImageResizer({
         host: url.host,
@@ -152,6 +135,39 @@ export function getBaseContext(input: {
     };
 }
 
+/**
+ * Get the linker for a given site URL.
+ */
+export function getLinkerForSiteURL(input: {
+    siteURL: URL;
+    urlMode: 'url' | 'url-host';
+}) {
+    const { siteURL, urlMode } = input;
+
+    const gitbookURL = GITBOOK_URL ? new URL(GITBOOK_URL) : undefined;
+    const linker =
+        urlMode === 'url-host'
+            ? createLinker({
+                  host: siteURL.host,
+                  pathname: siteURL.pathname,
+              })
+            : createLinker({
+                  protocol: gitbookURL?.protocol,
+                  host: gitbookURL?.host,
+                  pathname: `/url/${siteURL.host}${siteURL.pathname}`,
+              });
+
+    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}`;
+        };
+    }
+
+    return linker;
+}
+
 /**
  * Fetch the context of a site for a given URL and a base context.
  */

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

@@ -1,42 +1,40 @@
-import { type ComputedContentSource, GitBookAPI } from '@gitbook/api';
-import { getCacheTag, getComputedContentSourceCacheTags } from '@gitbook/cache-tags';
+import { trace } from '@/lib/tracing';
+import {
+    type ComputedContentSource,
+    GitBookAPI,
+    type GitBookAPIServiceBinding,
+} from '@gitbook/api';
+import {
+    getCacheTag,
+    getCacheTagForURL,
+    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 getAPI(input);
+            return apiClient(input);
         },
 
         withToken({ apiToken }) {
             return createDataFetcher({
-                ...input,
                 apiToken,
             });
         },
@@ -45,94 +43,120 @@ export function createDataFetcher(input: DataFetcherInput = commonInput): GitBoo
         // API that are tied to the token
         //
         getPublishedContentSite(params) {
-            return getPublishedContentSite(input, {
-                organizationId: params.organizationId,
-                siteId: params.siteId,
-                siteShareKey: params.siteShareKey,
-            });
+            return trace('getPublishedContentSite', () =>
+                getPublishedContentSite(input, {
+                    organizationId: params.organizationId,
+                    siteId: params.siteId,
+                    siteShareKey: params.siteShareKey,
+                })
+            );
         },
         getSiteRedirectBySource(params) {
-            return getSiteRedirectBySource(input, {
-                organizationId: params.organizationId,
-                siteId: params.siteId,
-                siteShareKey: params.siteShareKey,
-                source: params.source,
-            });
+            return trace('getSiteRedirectBySource', () =>
+                getSiteRedirectBySource(input, {
+                    organizationId: params.organizationId,
+                    siteId: params.siteId,
+                    siteShareKey: params.siteShareKey,
+                    source: params.source,
+                })
+            );
         },
         getRevision(params) {
-            return getRevision(input, {
-                spaceId: params.spaceId,
-                revisionId: params.revisionId,
-                metadata: params.metadata,
-            });
+            return trace('getRevision', () =>
+                getRevision(input, {
+                    spaceId: params.spaceId,
+                    revisionId: params.revisionId,
+                    metadata: params.metadata,
+                })
+            );
         },
         getRevisionPages(params) {
-            return getRevisionPages(input, {
-                spaceId: params.spaceId,
-                revisionId: params.revisionId,
-                metadata: params.metadata,
-            });
+            return trace('getRevisionPages', () =>
+                getRevisionPages(input, {
+                    spaceId: params.spaceId,
+                    revisionId: params.revisionId,
+                    metadata: params.metadata,
+                })
+            );
         },
         getRevisionFile(params) {
-            return getRevisionFile(input, {
-                spaceId: params.spaceId,
-                revisionId: params.revisionId,
-                fileId: params.fileId,
-            });
+            return trace('getRevisionFile', () =>
+                getRevisionFile(input, {
+                    spaceId: params.spaceId,
+                    revisionId: params.revisionId,
+                    fileId: params.fileId,
+                })
+            );
         },
         getRevisionPageByPath(params) {
-            return getRevisionPageByPath(input, {
-                spaceId: params.spaceId,
-                revisionId: params.revisionId,
-                path: params.path,
-            });
+            return trace('getRevisionPageByPath', () =>
+                getRevisionPageByPath(input, {
+                    spaceId: params.spaceId,
+                    revisionId: params.revisionId,
+                    path: params.path,
+                })
+            );
         },
         getReusableContent(params) {
-            return getReusableContent(input, {
-                spaceId: params.spaceId,
-                revisionId: params.revisionId,
-                reusableContentId: params.reusableContentId,
-            });
+            return trace('getReusableContent', () =>
+                getReusableContent(input, {
+                    spaceId: params.spaceId,
+                    revisionId: params.revisionId,
+                    reusableContentId: params.reusableContentId,
+                })
+            );
         },
         getLatestOpenAPISpecVersionContent(params) {
-            return getLatestOpenAPISpecVersionContent(input, {
-                organizationId: params.organizationId,
-                slug: params.slug,
-            });
+            return trace('getLatestOpenAPISpecVersionContent', () =>
+                getLatestOpenAPISpecVersionContent(input, {
+                    organizationId: params.organizationId,
+                    slug: params.slug,
+                })
+            );
         },
         getSpace(params) {
-            return getSpace(input, {
-                spaceId: params.spaceId,
-                shareKey: params.shareKey,
-            });
+            return trace('getSpace', () =>
+                getSpace(input, {
+                    spaceId: params.spaceId,
+                    shareKey: params.shareKey,
+                })
+            );
         },
         getChangeRequest(params) {
-            return getChangeRequest(input, {
-                spaceId: params.spaceId,
-                changeRequestId: params.changeRequestId,
-            });
+            return trace('getChangeRequest', () =>
+                getChangeRequest(input, {
+                    spaceId: params.spaceId,
+                    changeRequestId: params.changeRequestId,
+                })
+            );
         },
         getDocument(params) {
-            return getDocument(input, {
-                spaceId: params.spaceId,
-                documentId: params.documentId,
-            });
+            return trace('getDocument', () =>
+                getDocument(input, {
+                    spaceId: params.spaceId,
+                    documentId: params.documentId,
+                })
+            );
         },
         getComputedDocument(params) {
-            return getComputedDocument(input, {
-                organizationId: params.organizationId,
-                spaceId: params.spaceId,
-                source: params.source,
-            });
+            return trace('getComputedDocument', () =>
+                getComputedDocument(input, {
+                    organizationId: params.organizationId,
+                    spaceId: params.spaceId,
+                    source: params.source,
+                })
+            );
         },
         getEmbedByUrl(params) {
-            return getEmbedByUrl(input, {
-                url: params.url,
-                spaceId: params.spaceId,
-            });
+            return trace('getEmbedByUrl', () =>
+                getEmbedByUrl(input, {
+                    url: params.url,
+                    spaceId: params.spaceId,
+                })
+            );
         },
         searchSiteContent(params) {
-            return searchSiteContent(input, params);
+            return trace('searchSiteContent', () => searchSiteContent(input, params));
         },
 
         //
@@ -140,25 +164,31 @@ export function createDataFetcher(input: DataFetcherInput = commonInput): GitBoo
         // 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,
-            });
+            return trace('getPublishedContentByUrl', () =>
+                getPublishedContentByUrl(
+                    { apiToken: null },
+                    {
+                        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';
 
     cacheLife('days');
 
     return wrapDataFetcherError(async () => {
-        const res = await getAPI(input).users.getUserById(userId);
+        const api = await apiClient(input);
+        const res = await api.users.getUserById(params.userId);
         return res.data;
     });
 }
@@ -181,7 +211,8 @@ async function getSpace(
     );
 
     return wrapDataFetcherError(async () => {
-        const res = await getAPI(input).spaces.getSpaceById(params.spaceId, {
+        const api = await apiClient(input);
+        const res = await api.spaces.getSpaceById(params.spaceId, {
             shareKey: params.shareKey,
         });
         return res.data;
@@ -200,10 +231,8 @@ async function getChangeRequest(
     cacheLife('minutes');
 
     return wrapDataFetcherError(async () => {
-        const res = await getAPI(input).spaces.getChangeRequestById(
-            params.spaceId,
-            params.changeRequestId
-        );
+        const api = await apiClient(input);
+        const res = await api.spaces.getChangeRequestById(params.spaceId, params.changeRequestId);
         cacheTag(
             getCacheTag({
                 tag: 'change-request',
@@ -228,7 +257,8 @@ async function getRevision(
     cacheLife('max');
 
     return wrapDataFetcherError(async () => {
-        const res = await getAPI(input).spaces.getRevisionById(params.spaceId, params.revisionId, {
+        const api = await apiClient(input);
+        const res = await api.spaces.getRevisionById(params.spaceId, params.revisionId, {
             metadata: params.metadata,
         });
         return res.data;
@@ -248,13 +278,10 @@ async function getRevisionPages(
     cacheLife('max');
 
     return wrapDataFetcherError(async () => {
-        const res = await getAPI(input).spaces.listPagesInRevisionById(
-            params.spaceId,
-            params.revisionId,
-            {
-                metadata: params.metadata,
-            }
-        );
+        const api = await apiClient(input);
+        const res = await api.spaces.listPagesInRevisionById(params.spaceId, params.revisionId, {
+            metadata: params.metadata,
+        });
         return res.data.pages;
     });
 }
@@ -272,10 +299,12 @@ async function getRevisionFile(
     cacheLife('max');
 
     return wrapDataFetcherError(async () => {
-        const res = await getAPI(input).spaces.getFileInRevisionById(
+        const api = await apiClient(input);
+        const res = await api.spaces.getFileInRevisionById(
             params.spaceId,
             params.revisionId,
-            params.fileId
+            params.fileId,
+            {}
         );
         return res.data;
     });
@@ -295,10 +324,12 @@ async function getRevisionPageByPath(
 
     const encodedPath = encodeURIComponent(params.path);
     return wrapDataFetcherError(async () => {
-        const res = await getAPI(input).spaces.getPageInRevisionByPath(
+        const api = await apiClient(input);
+        const res = await api.spaces.getPageInRevisionByPath(
             params.spaceId,
             params.revisionId,
-            encodedPath
+            encodedPath,
+            {}
         );
 
         return res.data;
@@ -317,7 +348,8 @@ async function getDocument(
     cacheLife('max');
 
     return wrapDataFetcherError(async () => {
-        const res = await getAPI(input).spaces.getDocumentById(params.spaceId, params.documentId);
+        const api = await apiClient(input);
+        const res = await api.spaces.getDocumentById(params.spaceId, params.documentId, {});
         return res.data;
     });
 }
@@ -345,7 +377,8 @@ async function getComputedDocument(
     );
 
     return wrapDataFetcherError(async () => {
-        const res = await getAPI(input).spaces.getComputedDocument(params.spaceId, {
+        const api = await apiClient(input);
+        const res = await api.spaces.getComputedDocument(params.spaceId, {
             source: params.source,
         });
         return res.data;
@@ -365,7 +398,8 @@ async function getReusableContent(
     cacheLife('max');
 
     return wrapDataFetcherError(async () => {
-        const res = await getAPI(input).spaces.getReusableContentInRevisionById(
+        const api = await apiClient(input);
+        const res = await api.spaces.getReusableContentInRevisionById(
             params.spaceId,
             params.revisionId,
             params.reusableContentId
@@ -393,7 +427,8 @@ async function getLatestOpenAPISpecVersionContent(
     cacheLife('days');
 
     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
         );
@@ -413,17 +448,12 @@ async function getPublishedContentByUrl(
 
     const { url, visitorAuthToken, redirectOnError } = params;
 
-    const hostname = new URL(url).hostname;
-    cacheTag(
-        getCacheTag({
-            tag: 'url',
-            hostname,
-        })
-    );
+    cacheTag(getCacheTagForURL(url));
     cacheLife('days');
 
     return wrapDataFetcherError(async () => {
-        const res = await getAPI(input).urls.getPublishedContentByUrl({
+        const api = await apiClient(input);
+        const res = await api.urls.getPublishedContentByUrl({
             url,
             visitorAuthToken: visitorAuthToken ?? undefined,
             redirectOnError,
@@ -452,22 +482,19 @@ async function getPublishedContentSite(
 ) {
     'use cache';
 
+    cacheLife('days');
     cacheTag(
         getCacheTag({
             tag: 'site',
             site: params.siteId,
         })
     );
-    cacheLife('days');
 
     return wrapDataFetcherError(async () => {
-        const res = await getAPI(input).orgs.getPublishedContentSite(
-            params.organizationId,
-            params.siteId,
-            {
-                shareKey: params.siteShareKey,
-            }
-        );
+        const api = await apiClient(input);
+        const res = await api.orgs.getPublishedContentSite(params.organizationId, params.siteId, {
+            shareKey: params.siteShareKey,
+        });
         return res.data;
     });
 }
@@ -492,14 +519,11 @@ async function getSiteRedirectBySource(
     cacheLife('days');
 
     return wrapDataFetcherError(async () => {
-        const res = await getAPI(input).orgs.getSiteRedirectBySource(
-            params.organizationId,
-            params.siteId,
-            {
-                shareKey: params.siteShareKey,
-                source: params.source,
-            }
-        );
+        const api = await apiClient(input);
+        const res = await api.orgs.getSiteRedirectBySource(params.organizationId, params.siteId, {
+            shareKey: params.siteShareKey,
+            source: params.source,
+        });
 
         return res.data;
     });
@@ -517,7 +541,7 @@ async function getEmbedByUrl(
     cacheLife('weeks');
 
     return wrapDataFetcherError(async () => {
-        const api = getAPI(input);
+        const api = await apiClient(input);
         const res = await api.spaces.getEmbedByUrlInSpace(params.spaceId, { url: params.url });
         return res.data;
     });
@@ -534,7 +558,8 @@ async function searchSiteContent(
     cacheLife('days');
 
     return wrapDataFetcherError(async () => {
-        const res = await getAPI(input).orgs.searchSiteContent(organizationId, siteId, {
+        const api = await apiClient(input);
+        const res = await api.orgs.searchSiteContent(organizationId, siteId, {
             query,
             ...scope,
         });
@@ -542,12 +567,43 @@ async function searchSiteContent(
     });
 }
 
-function getAPI(input: DataFetcherInput) {
-    const { apiEndpoint, apiToken } = input;
+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,
-        endpoint: apiEndpoint,
+        authToken: apiToken || GITBOOK_API_TOKEN || undefined,
+        endpoint: GITBOOK_API_URL,
         userAgent: GITBOOK_USER_AGENT,
+        serviceBinding,
     });
 
     return api;

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

@@ -93,7 +93,10 @@ export async function wrapDataFetcherError<T>(
     }
 }
 
-function getExposableError(error: Error): DataFetcherErrorData {
+/**
+ * Get a data fetcher exposable error from a JS error.
+ */
+export function getExposableError(error: Error): DataFetcherErrorData {
     if (error instanceof GitBookAPIError) {
         return {
             code: error.code,

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

@@ -3,3 +3,4 @@ export * from './types';
 export * from './pages';
 export * from './urls';
 export * from './errors';
+export * from './lookup';

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

@@ -0,0 +1,128 @@
+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;
+}): 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();
+
+        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 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: {
+                code: 404,
+                message: 'No content found',
+            },
+        };
+    }
+
+    if (result.error) {
+        return {
+            error: getExposableError(result.error),
+        };
+    }
+
+    return {
+        data: result.data,
+    };
+}

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

@@ -20,11 +20,6 @@ export type DataFetcherResponse<T> =
  * It is used between v1 and v2.
  */
 export interface GitBookDataFetcher {
-    /**
-     * Endpoint of the API.
-     */
-    apiEndpoint: string;
-
     /**
      * Get an API client for the current context.
      */

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

@@ -1,121 +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);
-
-    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.

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

@@ -1,3 +1,11 @@
+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.
  */
@@ -14,23 +22,28 @@ export const GITBOOK_URL =
 export const GITBOOK_ASSETS_URL =
     process.env.NODE_ENV === 'development'
         ? 'http://localhost:3000'
-        : process.env.GITBOOK_ASSETS_PREFIX || GITBOOK_URL;
+        : process.env.GITBOOK_ASSETS_PREFIX;
 
 /**
  * GitBook app URL.
  */
-export const GITBOOK_APP_URL = process.env.NEXT_PUBLIC_GITBOOK_APP_URL || 'https://app.gitbook.com';
+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;
+export const GITBOOK_API_TOKEN = process.env.GITBOOK_API_TOKEN || null;
 
 /**
  * User agent to use for API requests.
@@ -59,6 +72,17 @@ export const GITBOOK_IMAGE_RESIZE_URL = process.env.GITBOOK_IMAGE_RESIZE_URL ??
 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.
  */

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

@@ -36,6 +36,12 @@ export enum MiddlewareHeaders {
      * The visitor token used to access this content
      */
     VisitorAuthToken = 'x-gitbook-visitor-token',
+
+    /**
+     * The API token used to fetch the content.
+     * This should only be passed for non-site dynamic routes.
+     */
+    APIToken = 'x-gitbook-api-token',
 }
 
 /**
@@ -112,3 +118,17 @@ export async function getVisitorAuthTokenFromMiddleware(): Promise<string | null
 
     return visitorAuthToken;
 }
+
+/**
+ * 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/middleware.ts

@@ -1,13 +1,25 @@
-import { CustomizationThemeMode, GitBookAPIError } from '@gitbook/api';
+import { CustomizationThemeMode } from '@gitbook/api';
 import type { NextRequest } from 'next/server';
 import { NextResponse } from 'next/server';
 
 import { getContentSecurityPolicy } from '@/lib/csp';
 import { validateSerializedCustomization } from '@/lib/customization';
 import { removeLeadingSlash, removeTrailingSlash } from '@/lib/paths';
-import { getResponseCookiesForVisitorAuth, getVisitorToken } from '@/lib/visitor-token';
+import {
+    type ResponseCookies,
+    getPathScopedCookieName,
+    getResponseCookiesForVisitorAuth,
+    getVisitorToken,
+    normalizeVisitorAuthURL,
+} from '@/lib/visitor-token';
 import { serveResizedImage } from '@/routes/image';
-import { getPublishedContentByURL } from '@v2/lib/data';
+import { getLinkerForSiteURL } from '@v2/lib/context';
+import {
+    DataFetcherError,
+    getPublishedContentByURL,
+    normalizeURL,
+    throwIfDataError,
+} from '@v2/lib/data';
 import { isGitBookAssetsHostURL, isGitBookHostURL } from '@v2/lib/env';
 import { MiddlewareHeaders } from '@v2/lib/middleware';
 
@@ -21,27 +33,21 @@ type URLWithMode = { url: URL; mode: 'url' | 'url-host' };
 
 export async function middleware(request: NextRequest) {
     try {
-        // Route all requests to a site
-        const extracted = getSiteURLFromRequest(request);
-        if (extracted) {
-            /**
-             * 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 (extracted.url.pathname.endsWith('/~gitbook/image')) {
-                return await serveResizedImage(request, {
-                    host: extracted.url.host,
-                });
-            }
+        const requestURL = new URL(request.url);
 
-            return await serveSiteByURL(request, extracted);
+        // Redirect to normalize the URL
+        const normalized = normalizeURL(requestURL);
+        if (normalized.toString() !== requestURL.toString()) {
+            return NextResponse.redirect(normalized.toString());
+        }
+
+        for (const handler of [serveSiteRoutes, servePreviewRoutes]) {
+            const result = await handler(requestURL, request);
+            if (result) {
+                return result;
+            }
         }
 
-        // Handle the rest with the router default logic
         return NextResponse.next();
     } catch (error) {
         return serveErrorResponse(error as Error);
@@ -49,50 +55,111 @@ export async function middleware(request: NextRequest) {
 }
 
 /**
- * Serve site by URL.
+ * Handle request that are targetting the site routes group.
  */
-async function serveSiteByURL(request: NextRequest, urlWithMode: URLWithMode) {
-    const { url, mode } = urlWithMode;
-
-    // Visitor authentication
-    // @ts-ignore - request typing
-    const visitorToken = getVisitorToken(request, url);
-
-    const result = await getPublishedContentByURL({
-        url: url.toString(),
-        visitorAuthToken: visitorToken?.token ?? null,
-        // When the visitor auth token is pulled from the cookie, set redirectOnError when calling getPublishedContentByUrl to allow
-        // 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',
-    });
-
-    if (result.error) {
-        throw result.error;
+async function serveSiteRoutes(requestURL: URL, request: NextRequest) {
+    const match = getSiteURLFromRequest(request);
+    if (!match) {
+        return null;
     }
 
-    const { data } = result;
+    const { url: siteURL, mode } = match;
 
+    /**
+     * 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(request, siteURL);
+
+    const data = await throwIfDataError(
+        getPublishedContentByURL({
+            url: siteURL.toString(),
+            visitorAuthToken: visitorToken?.token ?? null,
+            // When the visitor auth token is pulled from the cookie, set redirectOnError when calling getPublishedContentByUrl to allow
+            // 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',
+        })
+    );
+    let cookies: ResponseCookies = {};
+
+    //
+    // Handle redirects
+    //
     if ('redirect' in data) {
+        // biome-ignore lint/suspicious/noConsole: we want to log the redirect
+        console.log('redirect', data.redirect);
+        if (data.target === 'content') {
+            // For content redirects, we use the linker to redirect the optimal URL
+            // during development and testing in 'url' mode.
+            const linker = getLinkerForSiteURL({
+                siteURL,
+                urlMode: mode,
+            });
+
+            const contentRedirect = new URL(linker.toLinkForContent(data.redirect), 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(data.redirect);
     }
 
+    cookies = {
+        ...cookies,
+        ...getResponseCookiesForVisitorAuth(data.basePath, 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 requestURLWithoutToken = normalizeVisitorAuthURL(requestURL);
+    if (requestURLWithoutToken.toString() !== requestURL.toString()) {
+        return writeResponseCookies(
+            NextResponse.redirect(requestURLWithoutToken.toString()),
+            cookies
+        );
+    }
+
+    //
+    // Render and serve the content
+    //
+
     // When visitor has authentication (adaptive content or VA), we serve dynamic routes.
     let routeType = visitorToken ? 'dynamic' : 'static';
 
     const requestHeaders = new Headers(request.headers);
     requestHeaders.set(MiddlewareHeaders.RouteType, routeType);
     requestHeaders.set(MiddlewareHeaders.URLMode, mode);
-    requestHeaders.set(MiddlewareHeaders.SiteURL, `${url.origin}${data.basePath}`);
+    requestHeaders.set(MiddlewareHeaders.SiteURL, `${siteURL.origin}${data.basePath}`);
     requestHeaders.set(MiddlewareHeaders.SiteURLData, JSON.stringify(data));
 
     // Preview of customization/theme
-    const customization = url.searchParams.get('customization');
+    const customization = siteURL.searchParams.get('customization');
     if (customization && validateSerializedCustomization(customization)) {
         routeType = 'dynamic';
         requestHeaders.set(MiddlewareHeaders.Customization, customization);
     }
-    const theme = url.searchParams.get('theme');
+    const theme = siteURL.searchParams.get('theme');
     if (theme === CustomizationThemeMode.Dark || theme === CustomizationThemeMode.Light) {
         routeType = 'dynamic';
         requestHeaders.set(MiddlewareHeaders.Theme, theme);
@@ -108,14 +175,16 @@ async function serveSiteByURL(request: NextRequest, urlWithMode: URLWithMode) {
     requestHeaders.set('x-forwarded-host', request.nextUrl.host);
     requestHeaders.set('origin', request.nextUrl.origin);
 
-    const siteURL = `${url.host}${data.basePath}`;
+    const siteURLWithoutProtocol = `${siteURL.host}${data.basePath}`;
+    const { pathname, routeType: routeTypeFromPathname } = encodePathInSiteContent(data.pathname);
+    routeType = routeTypeFromPathname ?? routeType;
 
     const route = [
         'sites',
         routeType,
         mode,
-        encodeURIComponent(siteURL),
-        encodePathInSiteContent(data.pathname),
+        encodeURIComponent(siteURLWithoutProtocol),
+        pathname,
     ].join('/');
 
     console.log(`rewriting ${request.nextUrl.toString()} to ${route}`);
@@ -135,24 +204,68 @@ async function serveSiteByURL(request: NextRequest, urlWithMode: URLWithMode) {
     response.headers.set('x-content-type-options', 'nosniff');
     // Debug header
     response.headers.set('x-gitbook-route-type', routeType);
-    response.headers.set('x-gitbook-site-url', siteURL);
+    response.headers.set('x-gitbook-route-site', siteURLWithoutProtocol);
 
-    if (visitorToken) {
-        const cookies = getResponseCookiesForVisitorAuth(data.basePath, visitorToken);
-        for (const [key, value] of Object.entries(cookies)) {
-            response.cookies.set(key, value.value, value.options);
-        }
+    return writeResponseCookies(response, cookies);
+}
+
+/**
+ * Serve routes for previewing unpublished content.
+ * Routes are:
+ *   - PDF export for a space: /~space/:spaceId/~gitbook/pdf
+ *   - Preview of an unpublished site: /~site/:siteId/
+ */
+async function servePreviewRoutes(requestURL: URL, request: NextRequest) {
+    const pathnameParts = requestURL.pathname.slice(1).split('/');
+
+    if (pathnameParts[0] !== '~space' && pathnameParts[0] !== '~site') {
+        return null;
     }
 
-    return response;
+    // We store the API token in a cookie that is scoped to the specific preview route
+    // to avoid errors when multiple previews are opened in different tabs.
+    const cookieName = getPathScopedCookieName(
+        'gitbook-api-token',
+        pathnameParts.slice(0, 2).join('/')
+    );
+
+    // 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 = requestURL.searchParams.get('token');
+    if (queryAPIToken) {
+        requestURL.searchParams.delete('token');
+        return writeResponseCookies(NextResponse.redirect(requestURL.toString()), {
+            [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);
+    }
+
+    // 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 GitBookAPIError) {
-        return new Response(error.errorMessage, {
+    if (error instanceof DataFetcherError) {
+        return new Response(error.message, {
             status: error.code,
             headers: { 'content-type': 'text/plain' },
         });
@@ -219,22 +332,27 @@ function getSiteURLFromRequest(request: NextRequest): URLWithMode | null {
  * Encode path in a site content.
  * Special paths are not encoded and passed to be handled by the route handlers.
  */
-function encodePathInSiteContent(rawPathname: string) {
+function encodePathInSiteContent(rawPathname: string): {
+    pathname: string;
+    routeType?: 'static' | 'dynamic';
+} {
     const pathname = removeLeadingSlash(removeTrailingSlash(rawPathname));
 
     if (pathname.match(/^~gitbook\/ogimage\/\S+$/)) {
-        return pathname;
+        return { pathname };
     }
 
     switch (pathname) {
         case '~gitbook/icon':
-        case '~gitbook/image':
         case 'llms.txt':
         case 'sitemap.xml':
         case 'robots.txt':
-            return pathname;
+            return { pathname };
+        case '~gitbook/pdf':
+            // PDF routes are always dynamic as they depend on the search params.
+            return { pathname, routeType: 'dynamic' };
         default:
-            return encodeURIComponent(pathname || '/');
+            return { pathname: encodeURIComponent(pathname || '/') };
     }
 }
 
@@ -248,3 +366,14 @@ function appendQueryParams(url: URL, from: URLSearchParams) {
 
     return url;
 }
+
+/**
+ * Write the cookies to a response.
+ */
+function writeResponseCookies<R extends NextResponse>(response: R, cookies: ResponseCookies): R {
+    Object.entries(cookies).forEach(([key, { value, options }]) => {
+        response.cookies.set(key, value, options);
+    });
+
+    return response;
+}

packages/gitbook-v2/wrangler.toml

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

packages/gitbook/e2e/customers.spec.ts

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

packages/gitbook/e2e/internal.spec.ts

@@ -14,10 +14,12 @@ import {
     getVisitorAuthCookieValue,
 } from '@/lib/visitor-token';
 
+import { getSiteAPIToken } from '../tests/utils';
 import {
     type TestsCase,
     allDeprecatedThemePresets,
     allLocales,
+    allSearchStyles,
     allSidebarBackgroundStyles,
     allThemeModes,
     allThemes,
@@ -31,7 +33,7 @@ import {
 const testCases: TestsCase[] = [
     {
         name: 'GitBook Site (Single Variant)',
-        baseUrl: 'https://gitbook-open-e2e-sites.gitbook.io/gitbook-doc/',
+        contentBaseURL: 'https://gitbook-open-e2e-sites.gitbook.io/gitbook-doc/',
         tests: [
             {
                 name: 'Home',
@@ -84,7 +86,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'GitBook Site (Multi Variants)',
-        baseUrl: 'https://gitbook-open-e2e-sites.gitbook.io/multi-variants/',
+        contentBaseURL: 'https://gitbook-open-e2e-sites.gitbook.io/multi-variants/',
         tests: [
             {
                 name: 'Variants dropdown',
@@ -135,7 +137,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'GitBook Site (Navigation when switching variant)',
-        baseUrl: 'https://gitbook-open-e2e-sites.gitbook.io/',
+        contentBaseURL: 'https://gitbook-open-e2e-sites.gitbook.io/',
         tests: [
             {
                 name: 'Keep navigation path/route when switching variant (Public)',
@@ -155,8 +157,8 @@ const testCases: TestsCase[] = [
                         .click();
 
                     // It should keep the current page path, i.e "reference/api-reference/pets" when navigating to the new variant
-                    await page.waitForURL(
-                        'https://gitbook-open-e2e-sites.gitbook.io/api-multi-versions/2.0/reference/api-reference/pets?fallback=true'
+                    await page.waitForURL((url) =>
+                        url.pathname.includes('api-multi-versions/2.0/reference/api-reference/pets')
                     );
                 },
             },
@@ -178,15 +180,17 @@ const testCases: TestsCase[] = [
                         .click();
 
                     // It should keep the current page path, i.e "reference/api-reference/pets" when navigating to the new variant
-                    await page.waitForURL(
-                        'https://gitbook-open-e2e-sites.gitbook.io/api-multi-versions-share-links/8tNo6MeXg7CkFMzSSz81/2.0/reference/api-reference/pets?fallback=true'
+                    await page.waitForURL((url) =>
+                        url.pathname.includes(
+                            'api-multi-versions-share-links/8tNo6MeXg7CkFMzSSz81/2.0/reference/api-reference/pets'
+                        )
                     );
                 },
             },
             {
                 name: 'Keep navigation path/route when switching variant (VA)',
                 screenshot: false,
-                url: (() => {
+                url: () => {
                     const privateKey = 'c26190fc-74b2-4b54-9fc7-df9941104953';
                     const token = jwt.sign(
                         {
@@ -198,7 +202,7 @@ const testCases: TestsCase[] = [
                         }
                     );
                     return `api-multi-versions-va/reference/api-reference/pets?jwt_token=${token}`;
-                })(),
+                },
                 run: async (page) => {
                     const spaceDrowpdown = await page
                         .locator('[data-testid="space-dropdown-button"]')
@@ -213,8 +217,10 @@ const testCases: TestsCase[] = [
                         .click();
 
                     // It should keep the current page path, i.e "reference/api-reference/pets" when navigating to the new variant
-                    await page.waitForURL(
-                        'https://gitbook-open-e2e-sites.gitbook.io/api-multi-versions-va/2.0/reference/api-reference/pets?fallback=true'
+                    await page.waitForURL((url) =>
+                        url.pathname.includes(
+                            'api-multi-versions-va/2.0/reference/api-reference/pets'
+                        )
                     );
                 },
             },
@@ -222,7 +228,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'GitBook Site (Sections and Section Groups)',
-        baseUrl: 'https://gitbook-open-e2e-sites.gitbook.io/sections/',
+        contentBaseURL: 'https://gitbook-open-e2e-sites.gitbook.io/sections/',
         tests: [
             {
                 name: 'Site with sections and section groups',
@@ -244,16 +250,14 @@ const testCases: TestsCase[] = [
                     const sectionGroupDropdown = await page.getByText('Test Section Group 1');
                     await sectionGroupDropdown.hover();
                     await page.getByText('Section B').click();
-                    await page.waitForURL(
-                        'https://gitbook-open-e2e-sites.gitbook.io/sections/sections-4'
-                    );
+                    await page.waitForURL((url) => url.pathname.includes('/sections/sections-4'));
                 },
             },
         ],
     },
     {
         name: 'GitBook',
-        baseUrl: 'https://docs.gitbook.com',
+        contentBaseURL: 'https://docs.gitbook.com',
         tests: [
             {
                 name: 'Home',
@@ -297,7 +301,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'Versioning',
-        baseUrl: 'https://gitbook.gitbook.io/test-gitbook-open/',
+        contentBaseURL: 'https://gitbook.gitbook.io/test-gitbook-open/',
         tests: [
             {
                 name: 'Revision',
@@ -308,7 +312,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'PDF',
-        baseUrl: 'https://gitbook.gitbook.io/test-gitbook-open/',
+        contentBaseURL: 'https://gitbook.gitbook.io/test-gitbook-open/',
         tests: [
             {
                 name: 'PDF',
@@ -316,12 +320,56 @@ const testCases: TestsCase[] = [
                 screenshot: {
                     waitForTOCScrolling: false,
                 },
+                run: async (page) => {
+                    await expect(page.locator('[data-testid="print-button"]')).toBeVisible();
+                },
+            },
+        ],
+    },
+    {
+        name: 'Space PDF',
+        tests: [
+            {
+                name: 'Main content',
+                url: async () => {
+                    const data = await getSiteAPIToken(
+                        'https://gitbook.gitbook.io/test-gitbook-open/'
+                    );
+
+                    const searchParams = new URLSearchParams();
+                    searchParams.set('limit', '10');
+                    searchParams.set('token', data.apiToken);
+
+                    return `~space/${data.space}/~gitbook/pdf?${searchParams.toString()}`;
+                },
+                screenshot: false,
+                run: async (page) => {
+                    await expect(page.locator('[data-testid="print-button"]')).toBeVisible();
+                },
+            },
+            {
+                name: 'Change request',
+                url: async () => {
+                    const data = await getSiteAPIToken(
+                        'https://gitbook.gitbook.io/test-gitbook-open/'
+                    );
+
+                    const searchParams = new URLSearchParams();
+                    searchParams.set('limit', '10');
+                    searchParams.set('token', data.apiToken);
+
+                    return `~space/${data.space}/~/changes/HrtgUd5MlFusCMv1elA7/~gitbook/pdf?${searchParams.toString()}`;
+                },
+                screenshot: false,
+                run: async (page) => {
+                    await expect(page.locator('[data-testid="print-button"]')).toBeVisible();
+                },
             },
         ],
     },
     {
         name: 'Content tests',
-        baseUrl: 'https://gitbook.gitbook.io/test-gitbook-open/',
+        contentBaseURL: 'https://gitbook.gitbook.io/test-gitbook-open/',
         tests: [
             {
                 name: 'Text',
@@ -484,7 +532,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'Page options',
-        baseUrl: 'https://gitbook.gitbook.io/test-gitbook-open/',
+        contentBaseURL: 'https://gitbook.gitbook.io/test-gitbook-open/',
         tests: [
             {
                 name: 'Hidden',
@@ -518,7 +566,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'Customization',
-        baseUrl: 'https://gitbook.gitbook.io/test-gitbook-open/',
+        contentBaseURL: 'https://gitbook.gitbook.io/test-gitbook-open/',
         tests: allThemeModes.flatMap((themeMode) => [
             {
                 name: `Without header - Theme mode ${themeMode}`,
@@ -600,6 +648,23 @@ const testCases: TestsCase[] = [
                         run: waitForCookiesDialog,
                     })),
                 ]),
+                ...allSearchStyles.flatMap((searchStyle) => ({
+                    name: `Theme ${theme} – Search ${searchStyle} – Mode ${themeMode}`,
+                    url: getCustomizationURL({
+                        styling: {
+                            theme,
+                            search: searchStyle,
+                        },
+                        header: {
+                            links: headerLinks,
+                        },
+                        themes: {
+                            default: themeMode,
+                            toggeable: false,
+                        },
+                    }),
+                    run: waitForCookiesDialog,
+                })),
             ]),
             // Deprecated header themes
             ...allDeprecatedThemePresets.flatMap((preset) => [
@@ -652,7 +717,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'Ads',
-        baseUrl: 'https://gitbook.gitbook.io/test-gitbook-open/',
+        contentBaseURL: 'https://gitbook.gitbook.io/test-gitbook-open/',
         tests: [
             {
                 name: 'Without previewed ads',
@@ -663,7 +728,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'Shared space navigation (first site)',
-        baseUrl: 'https://gitbook-open-e2e-sites.gitbook.io/shared-space-uno/',
+        contentBaseURL: 'https://gitbook-open-e2e-sites.gitbook.io/shared-space-uno/',
         tests: [
             {
                 name: 'Navigation to shared space',
@@ -684,7 +749,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'Shared space navigation (second site)',
-        baseUrl: 'https://gitbook-open-e2e-sites.gitbook.io/shared-space-dos/',
+        contentBaseURL: 'https://gitbook-open-e2e-sites.gitbook.io/shared-space-dos/',
         tests: [
             {
                 name: 'Navigation to shared space',
@@ -704,7 +769,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'Site Redirects',
-        baseUrl: 'https://gitbook-open-e2e-sites.gitbook.io/gitbook-doc/',
+        contentBaseURL: 'https://gitbook-open-e2e-sites.gitbook.io/gitbook-doc/',
         tests: [
             {
                 name: 'Redirect to SSO page',
@@ -718,7 +783,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'Share links',
-        baseUrl: 'https://gitbook.gitbook.io/gbo-tests-share-links/',
+        contentBaseURL: 'https://gitbook.gitbook.io/gbo-tests-share-links/',
         tests: [
             {
                 name: 'Valid link',
@@ -738,11 +803,11 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'Visitor Auth - Space',
-        baseUrl: 'https://gitbook.gitbook.io/gbo-va-space/',
+        contentBaseURL: 'https://gitbook.gitbook.io/gbo-va-space/',
         tests: [
             {
                 name: 'First',
-                url: (() => {
+                url: () => {
                     const privateKey = '70b844d0-c519-4532-8586-5970ce48c537';
                     const token = jwt.sign(
                         {
@@ -754,7 +819,7 @@ const testCases: TestsCase[] = [
                         }
                     );
                     return `first?jwt_token=${token}`;
-                })(),
+                },
                 run: async (page) => {
                     await expect(
                         page.getByRole('heading', { level: 1, name: 'first' })
@@ -764,7 +829,7 @@ const testCases: TestsCase[] = [
             },
             {
                 name: 'Second',
-                url: (() => {
+                url: () => {
                     const privateKey = '70b844d0-c519-4532-8586-5970ce48c537';
                     const token = jwt.sign(
                         {
@@ -776,7 +841,7 @@ const testCases: TestsCase[] = [
                         }
                     );
                     return `second?jwt_token=${token}`;
-                })(),
+                },
                 run: async (page) => {
                     await expect(
                         page.getByRole('heading', { level: 1, name: 'second' })
@@ -788,11 +853,11 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'Visitor Auth - Collection',
-        baseUrl: 'https://gitbook.gitbook.io/gbo-va-collection/',
+        contentBaseURL: 'https://gitbook.gitbook.io/gbo-va-collection/',
         tests: [
             {
                 name: 'Root',
-                url: (() => {
+                url: () => {
                     const privateKey = 'af5688dc-f0b6-4146-9b1d-6d834c62c980';
                     const token = jwt.sign(
                         {
@@ -804,12 +869,12 @@ const testCases: TestsCase[] = [
                         }
                     );
                     return `?jwt_token=${token}`;
-                })(),
+                },
                 run: waitForCookiesDialog,
             },
             {
                 name: 'Primary (Space A)',
-                url: (() => {
+                url: () => {
                     const privateKey = 'af5688dc-f0b6-4146-9b1d-6d834c62c980';
                     const token = jwt.sign(
                         {
@@ -820,13 +885,16 @@ const testCases: TestsCase[] = [
                             expiresIn: '24h',
                         }
                     );
+
+                    // Test that when accessing the non-canonical URL, we are redirected to the canonical URL
+                    // with the jwt token in the query string
                     return `spacea?jwt_token=${token}`;
-                })(),
+                },
                 run: waitForCookiesDialog,
             },
             {
                 name: 'Space B',
-                url: (() => {
+                url: () => {
                     const privateKey = 'af5688dc-f0b6-4146-9b1d-6d834c62c980';
                     const token = jwt.sign(
                         {
@@ -838,12 +906,12 @@ const testCases: TestsCase[] = [
                         }
                     );
                     return `spaceb?jwt_token=${token}`;
-                })(),
+                },
                 run: waitForCookiesDialog,
             },
             {
                 name: 'Space C',
-                url: (() => {
+                url: () => {
                     const privateKey = 'af5688dc-f0b6-4146-9b1d-6d834c62c980';
                     const token = jwt.sign(
                         {
@@ -855,18 +923,18 @@ const testCases: TestsCase[] = [
                         }
                     );
                     return `spacec?jwt_token=${token}`;
-                })(),
+                },
                 run: waitForCookiesDialog,
             },
         ],
     },
     {
         name: 'Visitor Auth - Space (custom domain)',
-        baseUrl: 'https://test.gitbook.community/',
+        contentBaseURL: 'https://test.gitbook.community/',
         tests: [
             {
                 name: 'Root',
-                url: (() => {
+                url: () => {
                     const privateKey = '19c8166f-c436-4ed1-a24e-60954b804021';
                     const token = jwt.sign(
                         {
@@ -878,12 +946,12 @@ const testCases: TestsCase[] = [
                         }
                     );
                     return `?jwt_token=${token}`;
-                })(),
+                },
                 run: waitForCookiesDialog,
             },
             {
                 name: 'First',
-                url: (() => {
+                url: () => {
                     const privateKey = '19c8166f-c436-4ed1-a24e-60954b804021';
                     const token = jwt.sign(
                         {
@@ -895,7 +963,7 @@ const testCases: TestsCase[] = [
                         }
                     );
                     return `first?jwt_token=${token}`;
-                })(),
+                },
                 run: async (page) => {
                     await expect(
                         page.getByRole('heading', { level: 1, name: 'first' })
@@ -905,7 +973,7 @@ const testCases: TestsCase[] = [
             },
             {
                 name: 'Custom page',
-                url: (() => {
+                url: () => {
                     const privateKey = '19c8166f-c436-4ed1-a24e-60954b804021';
                     const token = jwt.sign(
                         {
@@ -917,12 +985,12 @@ const testCases: TestsCase[] = [
                         }
                     );
                     return `custom-page?jwt_token=${token}`;
-                })(),
+                },
                 run: waitForCookiesDialog,
             },
             {
                 name: 'Inner page',
-                url: (() => {
+                url: () => {
                     const privateKey = '19c8166f-c436-4ed1-a24e-60954b804021';
                     const token = jwt.sign(
                         {
@@ -934,14 +1002,14 @@ const testCases: TestsCase[] = [
                         }
                     );
                     return `custom-page/inner-page?jwt_token=${token}`;
-                })(),
+                },
                 run: waitForCookiesDialog,
             },
         ],
     },
     {
         name: 'Visitor Auth - Site (redirects to fallback/auth URL)',
-        baseUrl: 'https://gitbook-open-e2e-sites.gitbook.io/va-site-redirects-fallback/',
+        contentBaseURL: 'https://gitbook-open-e2e-sites.gitbook.io/va-site-redirects-fallback/',
         tests: [
             {
                 name: 'Redirect to fallback on invalid token pulled from cookie',
@@ -973,7 +1041,7 @@ const testCases: TestsCase[] = [
             {
                 name: 'Show error message when invalid token is passed to url',
                 screenshot: false,
-                url: (() => {
+                url: () => {
                     const token = jwt.sign(
                         {
                             name: 'gitbook-open-tests',
@@ -984,7 +1052,7 @@ const testCases: TestsCase[] = [
                         }
                     );
                     return `?jwt_token=${token}`;
-                })(),
+                },
                 run: async (page) => {
                     await expect(page.locator('pre')).toContainText(
                         'Error while validating the JWT token. Reason: The token signature is invalid.'
@@ -995,7 +1063,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'Languages',
-        baseUrl: 'https://gitbook.gitbook.io/test-gitbook-open/',
+        contentBaseURL: 'https://gitbook.gitbook.io/test-gitbook-open/',
         tests: allLocales.map((locale) => ({
             name: locale,
             url: getCustomizationURL({
@@ -1011,7 +1079,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'SEO',
-        baseUrl: 'https://gitbook.gitbook.io/test-gitbook-open/',
+        contentBaseURL: 'https://gitbook.gitbook.io/test-gitbook-open/',
         tests: [
             {
                 name: 'Index by default',
@@ -1062,11 +1130,11 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'Adaptive Content - VA',
-        baseUrl: 'https://gitbook-open-e2e-sites.gitbook.io/adaptive-content-va/',
+        contentBaseURL: 'https://gitbook-open-e2e-sites.gitbook.io/adaptive-content-va/',
         tests: [
             {
                 name: 'isAlphaUser',
-                url: (() => {
+                url: () => {
                     const privateKey = 'afe09cdf-0f43-480a-b54c-8b1f62f174f9';
                     const token = jwt.sign(
                         {
@@ -1079,7 +1147,7 @@ const testCases: TestsCase[] = [
                         }
                     );
                     return `?jwt_token=${token}`;
-                })(),
+                },
                 run: async (page) => {
                     const alphaUserPage = page
                         .locator('a[class*="group\\/toclink"]')
@@ -1093,7 +1161,7 @@ const testCases: TestsCase[] = [
             },
             {
                 name: 'isBetaUser',
-                url: (() => {
+                url: () => {
                     const privateKey = 'afe09cdf-0f43-480a-b54c-8b1f62f174f9';
                     const token = jwt.sign(
                         {
@@ -1106,7 +1174,7 @@ const testCases: TestsCase[] = [
                         }
                     );
                     return `?jwt_token=${token}`;
-                })(),
+                },
                 run: async (page) => {
                     const alphaUserPage = page
                         .locator('a[class*="group\\/toclink"]')
@@ -1120,7 +1188,7 @@ const testCases: TestsCase[] = [
             },
             {
                 name: 'isAlphaUser & isBetaUser',
-                url: (() => {
+                url: () => {
                     const privateKey = 'afe09cdf-0f43-480a-b54c-8b1f62f174f9';
                     const token = jwt.sign(
                         {
@@ -1134,7 +1202,7 @@ const testCases: TestsCase[] = [
                         }
                     );
                     return `?jwt_token=${token}`;
-                })(),
+                },
                 run: async (page) => {
                     const alphaUserPage = page
                         .locator('a[class*="group\\/toclink"]')
@@ -1150,7 +1218,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'Adaptive Content - Public',
-        baseUrl: 'https://gitbook-open-e2e-sites.gitbook.io/adaptive-content-public/',
+        contentBaseURL: 'https://gitbook-open-e2e-sites.gitbook.io/adaptive-content-public/',
         tests: [
             {
                 name: 'No custom cookie',
@@ -1293,7 +1361,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'Tables',
-        baseUrl: 'https://gitbook.gitbook.io/test-gitbook-open/',
+        contentBaseURL: 'https://gitbook.gitbook.io/test-gitbook-open/',
         tests: [
             {
                 name: 'Default table',

packages/gitbook/e2e/util.ts

@@ -2,12 +2,13 @@ import { argosScreenshot } from '@argos-ci/playwright';
 import {
     CustomizationBackground,
     CustomizationCorners,
-    CustomizationFont,
+    CustomizationDefaultFont,
     type CustomizationHeaderItem,
     CustomizationHeaderPreset,
     CustomizationIconsStyle,
     CustomizationLinksStyle,
     CustomizationLocale,
+    CustomizationSearchStyle,
     CustomizationSidebarBackgroundStyle,
     CustomizationSidebarListStyle,
     CustomizationTheme,
@@ -20,14 +21,14 @@ import deepMerge from 'deepmerge';
 import rison from 'rison';
 import type { DeepPartial } from 'ts-essentials';
 
-import { getContentTestURL } from '../tests/utils';
+import { getContentTestURL, getTestURL } from '../tests/utils';
 
 export interface Test {
     name: string;
     /**
      * URL to visit for testing.
      */
-    url: string;
+    url: string | (() => string | Promise<string>);
     cookies?: Parameters<BrowserContext['addCookies']>[0];
     /**
      * Test to run
@@ -60,11 +61,11 @@ export interface Test {
     only?: boolean;
 }
 
-export interface TestsCase {
+export type TestsCase = {
     name: string;
-    baseUrl: string;
     tests: Array<Test>;
-}
+    contentBaseURL?: string;
+};
 
 export const allLocales: CustomizationLocale[] = [
     CustomizationLocale.Fr,
@@ -109,6 +110,11 @@ export const allSidebarBackgroundStyles: CustomizationSidebarBackgroundStyle[] =
     CustomizationSidebarBackgroundStyle.Filled,
 ];
 
+export const allSearchStyles: CustomizationSearchStyle[] = [
+    CustomizationSearchStyle.Prominent,
+    CustomizationSearchStyle.Subtle,
+];
+
 // Common customization settings
 
 export const headerLinks: CustomizationHeaderItem[] = [
@@ -142,9 +148,14 @@ export function runTestCases(testCases: TestsCase[]) {
         test.describe(testCase.name, () => {
             for (const testEntry of testCase.tests) {
                 const testFn = testEntry.only ? test.only : test;
-                testFn(testEntry.name, async ({ page, baseURL, context }) => {
-                    const contentUrl = new URL(testEntry.url, testCase.baseUrl);
-                    const url = getContentTestURL(contentUrl.toString(), baseURL);
+                testFn(testEntry.name, async ({ page, context }) => {
+                    const testEntryPathname =
+                        typeof testEntry.url === 'function' ? await testEntry.url() : testEntry.url;
+                    const url = testCase.contentBaseURL
+                        ? getContentTestURL(
+                              new URL(testEntryPathname, testCase.contentBaseURL).toString()
+                          )
+                        : getTestURL(testEntryPathname);
                     if (testEntry.cookies) {
                         await context.addCookies(
                             testEntry.cookies.map((cookie) => ({
@@ -244,7 +255,7 @@ export function getCustomizationURL(partial: DeepPartial<SiteCustomizationSettin
             dangerColor: { light: '#FB2C36', dark: '#FB2C36' },
             successColor: { light: '#00C950', dark: '#00C950' },
             corners: CustomizationCorners.Rounded,
-            font: CustomizationFont.Inter,
+            font: CustomizationDefaultFont.Inter,
             background: CustomizationBackground.Plain,
             icons: CustomizationIconsStyle.Regular,
             links: CustomizationLinksStyle.Default,
@@ -252,6 +263,7 @@ export function getCustomizationURL(partial: DeepPartial<SiteCustomizationSettin
                 background: CustomizationSidebarBackgroundStyle.Default,
                 list: CustomizationSidebarListStyle.Default,
             },
+            search: CustomizationSearchStyle.Subtle,
         },
         internationalization: {
             locale: CustomizationLocale.En,

packages/gitbook/next.config.js

@@ -1,83 +1,49 @@
-const { withSentryConfig } = require('@sentry/nextjs');
-
-module.exports = withSentryConfig(
-    {
-        env: {
-            BUILD_VERSION: (process.env.GITHUB_SHA ?? '').slice(0, 7),
-            SENTRY_RELEASE: process.env.SENTRY_RELEASE ?? '',
-            SENTRY_DSN: process.env.SENTRY_DSN ?? '',
-            SENTRY_ENVIRONMENT: process.env.SENTRY_ENVIRONMENT ?? 'development',
-            GITBOOK_ASSETS_PREFIX: process.env.GITBOOK_ASSETS_PREFIX,
-            GITBOOK_ICONS_URL: process.env.GITBOOK_ICONS_URL,
-            GITBOOK_ICONS_TOKEN: process.env.GITBOOK_ICONS_TOKEN,
-            NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: process.env.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY,
-        },
-
-        webpack(config, { dev, webpack }) {
-            config.resolve.fallback = {
-                ...config.resolve.fallback,
-
-                // Required for `swagger2openapi` to work:
-                fs: false,
-                path: false,
-                http: false,
-            };
-
-            // Tree shake debug code for Sentry
-            // https://docs.sentry.io/platforms/javascript/guides/nextjs/configuration/tree-shaking/#tree-shaking-with-nextjs
-            if (!dev) {
-                config.plugins.push(
-                    new webpack.DefinePlugin({
-                        __SENTRY_DEBUG__: false,
-                        // We always init Sentry with enableTracing: false for now, so this is useless
-                        __SENTRY_TRACING__: false,
-                        __RRWEB_EXCLUDE_IFRAME__: true,
-                        __RRWEB_EXCLUDE_SHADOW_DOM__: true,
-                        __SENTRY_EXCLUDE_REPLAY_WORKER__: true,
-                    })
-                );
-            }
-
-            return config;
-        },
-
-        async headers() {
-            return [
-                // Cache all static assets for 1 year
-                {
-                    source: '/~gitbook/static/:path*',
-                    headers: [
-                        {
-                            key: 'Cache-Control',
-                            value: 'public, max-age=31536000, immutable',
-                        },
-                    ],
-                },
-            ];
-        },
-
-        assetPrefix: process.env.GITBOOK_ASSETS_PREFIX,
-        poweredByHeader: false,
-
-        images: {
-            remotePatterns: [
-                {
-                    protocol: 'https',
-                    hostname: '*.gitbook.io',
-                },
-            ],
-        },
+module.exports = {
+    env: {
+        BUILD_VERSION: (process.env.GITHUB_SHA ?? '').slice(0, 7),
+        GITBOOK_ASSETS_PREFIX: process.env.GITBOOK_ASSETS_PREFIX,
+        GITBOOK_ICONS_URL: process.env.GITBOOK_ICONS_URL,
+        GITBOOK_ICONS_TOKEN: process.env.GITBOOK_ICONS_TOKEN,
+        NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: process.env.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY,
     },
-    {
-        release: process.env.SENTRY_RELEASE,
-        org: process.env.SENTRY_ORG,
-        project: process.env.SENTRY_PROJECT,
-        authToken: process.env.SENTRY_AUTH_TOKEN,
 
-        // Upload a larger set of source maps for prettier stack traces (increases build time)
-        widenClientFileUpload: true,
-        // Routes browser requests to Sentry through a Next.js rewrite to circumvent ad-blockers (increases server load)
-        tunnelRoute: '/~gitbook/monitoring',
-        disableLogger: true,
-    }
-);
+    webpack(config) {
+        config.resolve.fallback = {
+            ...config.resolve.fallback,
+
+            // Required for `swagger2openapi` to work:
+            fs: false,
+            path: false,
+            http: false,
+        };
+
+        return config;
+    },
+
+    async headers() {
+        return [
+            // Cache all static assets for 1 year
+            {
+                source: '/~gitbook/static/:path*',
+                headers: [
+                    {
+                        key: 'Cache-Control',
+                        value: 'public, max-age=31536000, immutable',
+                    },
+                ],
+            },
+        ];
+    },
+
+    assetPrefix: process.env.GITBOOK_ASSETS_PREFIX,
+    poweredByHeader: false,
+
+    images: {
+        remotePatterns: [
+            {
+                protocol: 'https',
+                hostname: '*.gitbook.io',
+            },
+        ],
+    },
+};

packages/gitbook/package.json

@@ -1,6 +1,6 @@
 {
     "name": "gitbook",
-    "version": "0.7.0",
+    "version": "0.8.1",
     "private": true,
     "scripts": {
         "dev": "env-cmd --silent -f ../../.env.local next dev",
@@ -16,7 +16,7 @@
         "clean": "rm -rf ./.next && rm -rf ./public/~gitbook/static/icons && rm -rf ./public/~gitbook/static/math"
     },
     "dependencies": {
-        "@gitbook/api": "0.96.1",
+        "@gitbook/api": "*",
         "@gitbook/cache-do": "workspace:*",
         "@gitbook/cache-tags": "workspace:*",
         "@gitbook/colors": "workspace:*",
@@ -29,7 +29,6 @@
         "@radix-ui/react-checkbox": "^1.0.4",
         "@radix-ui/react-navigation-menu": "^1.2.3",
         "@radix-ui/react-popover": "^1.0.7",
-        "@sentry/nextjs": "8.35.0",
         "@sindresorhus/fnv1a": "^3.1.0",
         "@tailwindcss/container-queries": "^0.1.1",
         "@tailwindcss/typography": "^0.5.16",
@@ -59,7 +58,7 @@
         "react-hotkeys-hook": "^4.4.1",
         "rison": "^0.1.1",
         "server-only": "^0.0.1",
-        "shiki": "^1.27.2",
+        "shiki": "^3.2.0",
         "tailwind-merge": "^2.2.0",
         "tailwind-shades": "^1.1.2",
         "url-join": "^5.0.0",

packages/gitbook/playwright.config.ts

@@ -16,7 +16,6 @@ export default defineConfig({
         },
     ],
     use: {
-        baseURL: process.env.BASE_URL || 'http://localhost:3000',
         trace: 'on-first-retry',
         screenshot: 'only-on-failure',
     },

packages/gitbook/sentry.client.config.ts

@@ -1,18 +0,0 @@
-import * as Sentry from '@sentry/browser';
-
-const dsn = process.env.SENTRY_DSN;
-if (dsn) {
-    Sentry.init({
-        dsn,
-        release: process.env.SENTRY_RELEASE,
-
-        // Disable tracing as it creates additional requests in an env where subrequests are limited.
-        tracesSampleRate: 0,
-
-        // Disable transactions  as it creates additional requests in an env where subrequests are limited.
-        // https://docs.sentry.io/platforms/node/configuration/filtering/#using--3
-        beforeSendTransaction: () => {
-            return null;
-        },
-    });
-}

packages/gitbook/src/app/global-error.tsx

@@ -1,14 +1,8 @@
 'use client';
 
-import { captureException } from '@sentry/nextjs';
 import NextError from 'next/error';
-import { useEffect } from 'react';
-
-export default function GlobalError({ error }: { error: Error }) {
-    useEffect(() => {
-        captureException(error);
-    }, [error]);
 
+export default function GlobalError() {
     return (
         <html lang="en">
             <body>

packages/gitbook/src/app/middleware/(site)/(content)/[[...pathname]]/page.tsx

@@ -38,10 +38,9 @@ export async function generateMetadata(props: PageProps): Promise<Metadata> {
 }
 
 async function getSitePageProps(props: PageProps) {
-    const { params: rawParams, searchParams: rawSearchParams } = props;
+    const { params: rawParams } = props;
 
     const params = await rawParams;
-    const searchParams = await rawSearchParams;
 
     const pointer = await getSiteContentPointer();
     const context = await fetchV1ContextForSitePointer(pointer);
@@ -49,7 +48,5 @@ async function getSitePageProps(props: PageProps) {
     return {
         context,
         pageParams: params,
-        redirectOnFallback: true,
-        fallback: !!searchParams.fallback,
     };
 }

packages/gitbook/src/app/middleware/(site)/error.tsx

@@ -1,8 +1,5 @@
 'use client';
 
-import { captureException, withScope } from '@sentry/nextjs';
-import React from 'react';
-
 import { Button } from '@/components/primitives/Button';
 import { t, useLanguage } from '@/intl/client';
 import { tcls } from '@/lib/tailwind';
@@ -11,18 +8,9 @@ export default function ErrorPage(props: {
     error: Error & { digest?: string };
     reset: () => void;
 }) {
-    const { error, reset } = props;
+    const { reset } = props;
     const language = useLanguage();
 
-    React.useEffect(() => {
-        withScope((scope) => {
-            if ('_componentStack' in error && error._componentStack) {
-                scope.setExtra('componentStack', error._componentStack);
-            }
-            captureException(error);
-        });
-    }, [error]);
-
     return (
         <div
             className={tcls(

packages/gitbook/src/app/middleware/(space)/~gitbook/pdf/layout.tsx

@@ -1,24 +1,9 @@
-import { CustomizationRootLayout } from '@/components/RootLayout';
-import { defaultCustomizationForSpace } from '@/lib/utils';
-
+import { PDFRootLayout } from '@/components/PDF';
 import { getV1ContextForPDF } from './pointer';
 
-/**
- * Layout to be used for the site root. It fetches the customization data for the
- * site or space and initializes the CustomizationRootLayout with it.
- */
-export default async function PDFRootLayout(props: { children: React.ReactNode }) {
+export default async function RootLayout(props: { children: React.ReactNode }) {
     const { children } = props;
-
     const context = await getV1ContextForPDF();
 
-    return (
-        <CustomizationRootLayout
-            customization={
-                'customization' in context ? context.customization : defaultCustomizationForSpace()
-            }
-        >
-            {children}
-        </CustomizationRootLayout>
-    );
+    return <PDFRootLayout context={context}>{children}</PDFRootLayout>;
 }

packages/gitbook/src/app/middleware/(space)/~gitbook/pdf/page.tsx

@@ -1,361 +1,17 @@
-import {
-    type CustomizationSettings,
-    type Revision,
-    type RevisionPageDocument,
-    type RevisionPageGroup,
-    RevisionPageType,
-    type SiteCustomizationSettings,
-    SiteInsightsTrademarkPlacement,
-    type Space,
-} from '@gitbook/api';
-import { Icon } from '@gitbook/icons';
-import type { GitBookSpaceContext } from '@v2/lib/context';
-import { getPageDocument } from '@v2/lib/data';
-import type { GitBookSpaceLinker } from '@v2/lib/links';
-import type { Metadata } from 'next';
-import { notFound } from 'next/navigation';
-import * as React from 'react';
-
-import { DocumentView } from '@/components/DocumentView';
-import { TrademarkLink } from '@/components/TableOfContents/Trademark';
-import type { PolymorphicComponentProp } from '@/components/utils/types';
-import { getSpaceLanguage } from '@/intl/server';
-import { tString } from '@/intl/translate';
-import { getAbsoluteHref, getPagePDFContainerId } from '@/lib/links';
-import { resolvePageId } from '@/lib/pages';
-import { tcls } from '@/lib/tailwind';
-import { type PDFSearchParams, getPDFSearchParams } from '@/lib/urls';
-import { defaultCustomizationForSpace } from '@/lib/utils';
-
-import { PageControlButtons } from './PageControlButtons';
-import { PrintButton } from './PrintButton';
-import './pdf.css';
+import { PDFPage, generatePDFMetadata } from '@/components/PDF';
 import { getV1ContextForPDF } from './pointer';
 
-const DEFAULT_LIMIT = 100;
-
 export const runtime = 'edge';
 export const dynamic = 'force-dynamic';
 
-export async function generateMetadata(): Promise<Metadata> {
+export async function generateMetadata() {
     const context = await getV1ContextForPDF();
-
-    return {
-        title: 'site' in context ? context.site.title : context.space.title,
-        robots: 'noindex, nofollow',
-    };
+    return generatePDFMetadata(context);
 }
 
-/**
- * Render a space as a standalone HTML page that can be printed as a PDF.
- */
-export default async function PDFHTMLOutput(props: {
+export default async function Page(props: {
     searchParams: Promise<{ [key: string]: string }>;
 }) {
-    const searchParams = new URLSearchParams(await props.searchParams);
-    const pdfParams = getPDFSearchParams(new URLSearchParams(searchParams));
-
-    // Build current PDF URL and preserve all search params
-    let currentPDFUrl = await getAbsoluteHref('~gitbook/pdf', true);
-    currentPDFUrl += `?${searchParams.toString()}`;
-
-    // Fetch the context
-    const baseContext = await getV1ContextForPDF();
-
-    const customization =
-        'customization' in baseContext ? baseContext.customization : defaultCustomizationForSpace();
-    const language = getSpaceLanguage(customization);
-
-    // Compute the pages to render
-    const { pages, total } = selectPages(baseContext.pages, pdfParams);
-    const pageIds = pages.map(
-        ({ page }) => [page.id, getPagePDFContainerId(page)] as [string, string]
-    );
-
-    // Build a linker that create anchor links for the pages rendered in the PDF page.
-    const linker: GitBookSpaceLinker = {
-        ...baseContext.linker,
-        toPathForPage(input) {
-            if (pages.some((p) => p.page.id === input.page.id)) {
-                return `#${getPagePDFContainerId(input.page, input.anchor)}`;
-            }
-            if (input.page.type === RevisionPageType.Group) {
-                return '#';
-            }
-
-            // Use an absolute URL to the page
-            return input.page.urls.app;
-        },
-    };
-
-    const context: GitBookSpaceContext = {
-        ...baseContext,
-        linker,
-    };
-
-    return (
-        <div className="print-mode">
-            {pdfParams.back !== 'false' ? (
-                <div className={tcls('fixed', 'left-12', 'top-12', 'print:hidden', 'z-50')}>
-                    <a
-                        title={tString(language, 'pdf_goback')}
-                        href={pdfParams.back ?? linker.toAbsoluteURL(linker.toPathInContent(''))}
-                        className={tcls(
-                            'flex',
-                            'flex-row',
-                            'items-center',
-                            'justify-center',
-                            'text-sm',
-                            'text-tint',
-                            'hover:text-primary',
-                            'p-4',
-                            'rounded-full',
-                            'bg-white',
-                            'shadow-sm',
-                            'hover:shadow-md',
-                            'border-slate-300',
-                            'border'
-                        )}
-                    >
-                        <Icon icon="arrow-left" className={tcls('size-6')} />
-                    </a>
-                </div>
-            ) : null}
-
-            <div className={tcls('fixed', 'right-12', 'top-12', 'print:hidden', 'z-50')}>
-                <PrintButton
-                    title={tString(language, 'pdf_print')}
-                    className={tcls(
-                        'flex',
-                        'flex-row',
-                        'items-center',
-                        'justify-center',
-                        'text-sm',
-                        'text-tint',
-                        'hover:text-primary',
-                        'p-4',
-                        'rounded-full',
-                        'bg-white',
-                        'shadow-sm',
-                        'hover:shadow-md',
-                        'border-slate-300',
-                        'border'
-                    )}
-                >
-                    <Icon icon="print" className={tcls('size-6')} />
-                </PrintButton>
-            </div>
-
-            <PageControlButtons
-                pageIds={pageIds}
-                pdfHref={currentPDFUrl}
-                singlePageMode={!!pdfParams.only}
-                total={total}
-                limit={pdfParams.limit ?? DEFAULT_LIMIT}
-                trademark={
-                    customization.trademark.enabled ? (
-                        <TrademarkLink
-                            space={context.space}
-                            customization={customization}
-                            placement={SiteInsightsTrademarkPlacement.Pdf}
-                        />
-                    ) : null
-                }
-            />
-
-            {pdfParams.only ? null : (
-                <PDFSpaceIntro space={context.space} customization={customization} />
-            )}
-            {pages.map(({ page }) =>
-                page.type === 'group' ? (
-                    <PDFPageGroup key={page.id} space={context.space} page={page} />
-                ) : (
-                    <React.Suspense
-                        key={page.id}
-                        fallback={
-                            <PrintPage id={getPagePDFContainerId(page)}>
-                                <p>Loading...</p>
-                            </PrintPage>
-                        }
-                    >
-                        <PDFPageDocument page={page} context={context} />
-                    </React.Suspense>
-                )
-            )}
-        </div>
-    );
-}
-
-async function PDFSpaceIntro(props: {
-    space: Space;
-    customization: CustomizationSettings | SiteCustomizationSettings;
-}) {
-    const { space, customization } = props;
-
-    return (
-        <PrintPage isFirst>
-            <div className={tcls('flex', 'items-center', 'justify-center', 'py-12')}>
-                <h1 className={tcls('text-6xl', 'font-bold')}>
-                    {customization.title ?? space.title}
-                </h1>
-            </div>
-        </PrintPage>
-    );
-}
-
-async function PDFPageGroup(props: { space: Space; page: RevisionPageGroup }) {
-    const { page } = props;
-
-    return (
-        <PrintPage id={getPagePDFContainerId(page)}>
-            <div
-                className={tcls(
-                    'break-before-page',
-                    'mt-10',
-                    'print:mt-0',
-                    'flex',
-                    'items-center',
-                    'justify-center',
-                    'py-12'
-                )}
-            >
-                <h1 className={tcls('text-5xl', 'font-bold')}>{page.title}</h1>
-            </div>
-        </PrintPage>
-    );
-}
-
-async function PDFPageDocument(props: {
-    page: RevisionPageDocument;
-    context: GitBookSpaceContext;
-}) {
-    const { page, context } = props;
-    const { space } = context;
-    const document = await getPageDocument(context.dataFetcher, space, page);
-
-    return (
-        <PrintPage id={getPagePDFContainerId(page)}>
-            <h1 className={tcls('text-4xl', 'font-bold')}>{page.title}</h1>
-            {page.description ? (
-                <p className={tcls('decoration-primary/6', 'mt-2', 'mb-3')}>{page.description}</p>
-            ) : null}
-
-            {document ? (
-                <DocumentView
-                    document={document}
-                    style="mt-6 space-y-6"
-                    blockStyle="max-w-full"
-                    context={{
-                        mode: 'print',
-                        contentContext: {
-                            ...context,
-                            page,
-                        },
-                        getId: (id) => getPagePDFContainerId(page, id),
-                    }}
-                />
-            ) : null}
-        </PrintPage>
-    );
-}
-
-function PrintPage(
-    props: PolymorphicComponentProp<
-        'div',
-        {
-            isFirst?: boolean;
-        }
-    >
-) {
-    const { children, isFirst, className, ...rest } = props;
-
-    return (
-        <div
-            {...rest}
-            className={tcls(
-                className,
-                'my-11',
-                'print:my-0',
-                'mx-auto',
-                'max-w-4xl',
-                'w-full',
-                'p-12',
-                'print:p-0',
-                'shadow-xl',
-                'print:shadow-none',
-                'rounded-sm',
-                'bg-white',
-                'min-h-[29.7cm]',
-                'print:min-h-0',
-                isFirst ? null : 'break-before-page',
-                'break-anywhere'
-            )}
-        >
-            {children}
-        </div>
-    );
-}
-
-type FlatPageEntry = { page: RevisionPageDocument | RevisionPageGroup; depth: number };
-
-/**
- * Compute the ordered flat set of pages to render.
- */
-function selectPages(
-    rootPages: Revision['pages'],
-    params: PDFSearchParams
-): { pages: FlatPageEntry[]; total: number } {
-    const flattenPage = (
-        page: RevisionPageDocument | RevisionPageGroup,
-        depth: number
-    ): FlatPageEntry[] => {
-        return [
-            { page, depth },
-            ...page.pages.flatMap((child) => {
-                if (child.type !== 'document') {
-                    return [];
-                }
-
-                if (child.hidden) {
-                    return [];
-                }
-
-                return flattenPage(child, depth + 1);
-            }),
-        ];
-    };
-
-    const limitTo = (entries: FlatPageEntry[]) => {
-        return {
-            // Apply a soft-limit, the limit can be controlled by the URL to allow testing
-            pages: entries.slice(0, params.limit ?? DEFAULT_LIMIT),
-            total: entries.length,
-        };
-    };
-
-    if (params.page) {
-        const found = resolvePageId(rootPages, params.page);
-        if (!found) {
-            notFound();
-        }
-
-        if (!params.only) {
-            return limitTo([{ page: found.page, depth: 0 }]);
-        }
-
-        return limitTo(flattenPage(found.page, 0));
-    }
-
-    const allPages = rootPages.flatMap((page) => {
-        if (page.type !== 'document' && page.type !== 'group') {
-            return [];
-        }
-
-        if (page.hidden) {
-            return [];
-        }
-
-        return flattenPage(page, 0);
-    });
-    return limitTo(allPages);
+    const context = await getV1ContextForPDF();
+    return <PDFPage context={context} searchParams={await props.searchParams} />;
 }

packages/gitbook/src/app/middleware/(space)/~gitbook/pdf/pointer.ts

@@ -4,23 +4,6 @@ import type { SiteContentPointer, SpaceContentPointer } from '@/lib/api';
 import { getSiteContentPointer, getSpacePointer } from '@/lib/pointer';
 import { fetchV1ContextForSitePointer, fetchV1ContextForSpacePointer } from '@/lib/v1';
 
-/**
- * PDF generation can be done at the site level (e.g. docs.foo.com/~gitbook/pdf) or
- * at the space level (e.g. open.gitbook.com/~space/:spaceId/~gitbook/pdf) which is
- * for PDF export of in-app private spaces.
- *
- * This function returns the pointer depending on the context.
- */
-export async function getSiteOrSpacePointerForPDF(): Promise<
-    SiteContentPointer | SpaceContentPointer
-> {
-    try {
-        return await getSiteContentPointer();
-    } catch (_error) {
-        return getSpacePointer();
-    }
-}
-
 /**
  * Get the context for the PDF pointer.
  */
@@ -31,3 +14,18 @@ export async function getV1ContextForPDF(): Promise<GitBookSiteContext | GitBook
         ? await fetchV1ContextForSitePointer(pointer)
         : await fetchV1ContextForSpacePointer(pointer);
 }
+
+/**
+ * PDF generation can be done at the site level (e.g. docs.foo.com/~gitbook/pdf) or
+ * at the space level (e.g. open.gitbook.com/~space/:spaceId/~gitbook/pdf) which is
+ * for PDF export of in-app private spaces.
+ *
+ * This function returns the pointer depending on the context.
+ */
+async function getSiteOrSpacePointerForPDF(): Promise<SiteContentPointer | SpaceContentPointer> {
+    try {
+        return await getSiteContentPointer();
+    } catch (_error) {
+        return getSpacePointer();
+    }
+}

packages/gitbook/src/cloudflare-entrypoint.ts

@@ -1,6 +1,7 @@
 // @ts-ignore
 import nextOnPagesHandler from '@cloudflare/next-on-pages/fetch-handler';
 
+import { withResponseCacheTags } from './lib/cache/response';
 import { withMiddlewareHeadersStorage } from './lib/middleware';
 
 /**
@@ -9,8 +10,8 @@ import { withMiddlewareHeadersStorage } from './lib/middleware';
  */
 export default {
     async fetch(request, env, ctx) {
-        const response = await withMiddlewareHeadersStorage(() =>
-            nextOnPagesHandler.fetch(request, env, ctx)
+        const response = await withResponseCacheTags(() =>
+            withMiddlewareHeadersStorage(() => nextOnPagesHandler.fetch(request, env, ctx))
         );
 
         return response;

packages/gitbook/src/components/AdminToolbar/AdminToolbar.tsx

@@ -48,7 +48,7 @@ function ToolbarLayout(props: { children: React.ReactNode }) {
  */
 export async function AdminToolbar(props: AdminToolbarProps) {
     const { context } = props;
-    const mode = await headers().get('x-gitbook-mode');
+    const mode = (await headers()).get('x-gitbook-mode');
 
     if (mode === 'multi-id') {
         // We don't show the admin toolbar in multi-id mode, as it's used for previewing in the dashboard.

packages/gitbook/src/components/DocumentView/Block.tsx

@@ -25,7 +25,7 @@ import { IntegrationBlock } from './Integration';
 import { List } from './List';
 import { ListItem } from './ListItem';
 import { BlockMath } from './Math';
-import { OpenAPI } from './OpenAPI';
+import { OpenAPIOperation, OpenAPISchemas } from './OpenAPI';
 import { Paragraph } from './Paragraph';
 import { Quote } from './Quote';
 import { ReusableContent } from './ReusableContent';
@@ -82,7 +82,9 @@ export function Block<T extends DocumentBlock>(props: BlockProps<T>) {
                 return <Table {...props} block={block} />;
             case 'swagger':
             case 'openapi-operation':
-                return <OpenAPI {...props} block={block} />;
+                return <OpenAPIOperation {...props} block={block} />;
+            case 'openapi-schemas':
+                return <OpenAPISchemas {...props} block={block} />;
             case 'embed':
                 return <Embed {...props} block={block} />;
             case 'blockquote':
@@ -156,6 +158,7 @@ export function BlockSkeleton(props: { block: DocumentBlock; style: ClassValue }
         case 'table':
         case 'swagger':
         case 'openapi-operation':
+        case 'openapi-schemas':
         case 'math':
         case 'divider':
         case 'content-ref':

packages/gitbook/src/components/DocumentView/Blocks.tsx

@@ -42,16 +42,18 @@ type UnwrappedBlocksProps<TBlock extends DocumentBlock> = DocumentContextProps &
 
     /** Style passed to all blocks */
     blockStyle?: ClassValue;
+
+    /** True if all blocks should be considered offscreen */
+    isOffscreen?: boolean;
 };
 
 /**
  * Renders a list of blocks without a wrapper element.
  */
 export function UnwrappedBlocks<TBlock extends DocumentBlock>(props: UnwrappedBlocksProps<TBlock>) {
-    const { nodes, blockStyle, ...contextProps } = props;
-
-    let isOffscreen = false;
+    const { nodes, blockStyle, isOffscreen: defaultIsOffscreen = false, ...contextProps } = props;
 
+    let isOffscreen = defaultIsOffscreen;
     return nodes.map((node) => {
         isOffscreen =
             isOffscreen ||

packages/gitbook/src/components/DocumentView/CodeBlock/ClientCodeBlock.tsx

@@ -1,11 +1,11 @@
 'use client';
 
 import type { DocumentBlockCode } from '@gitbook/api';
-import { useEffect, useRef, useState } from 'react';
+import { useEffect, useMemo, useRef, useState } from 'react';
 
 import { useInViewportListener } from '@/components/hooks/useInViewportListener';
 import { useScrollListener } from '@/components/hooks/useScrollListener';
-import { useDebounceCallback, useEventCallback } from 'usehooks-ts';
+import { useDebounceCallback } from 'usehooks-ts';
 import type { BlockProps } from '../Block';
 import { CodeBlockRenderer } from './CodeBlockRenderer';
 import type { HighlightLine, RenderedInline } from './highlight';
@@ -22,53 +22,82 @@ type ClientBlockProps = Pick<BlockProps<DocumentBlockCode>, 'block' | 'style'> &
 export function ClientCodeBlock(props: ClientBlockProps) {
     const { block, style, inlines } = props;
     const blockRef = useRef<HTMLDivElement>(null);
-    const processedRef = useRef(false);
-    const isInViewportRef = useRef<boolean | null>(null);
-    const [lines, setLines] = useState<HighlightLine[]>(() => plainHighlight(block, []));
+    const isInViewportRef = useRef(false);
+    const [isInViewport, setIsInViewport] = useState(false);
+    const plainLines = useMemo(() => plainHighlight(block, []), [block]);
+    const [lines, setLines] = useState<null | HighlightLine[]>(null);
 
     // Preload the highlighter when the block is mounted.
     useEffect(() => {
         import('./highlight').then(({ preloadHighlight }) => preloadHighlight(block));
     }, [block]);
 
-    const runHighlight = useEventCallback(() => {
-        if (processedRef.current) {
-            return;
-        }
-        if (typeof window !== 'undefined') {
-            import('./highlight').then(({ highlight }) => {
-                highlight(block, inlines).then((lines) => {
-                    setLines(lines);
-                    processedRef.current = true;
-                });
-            });
-        }
-    });
-    const debouncedRunHighlight = useDebounceCallback(runHighlight, 1000);
+    // When user scrolls, we need to wait for the scroll to finish before running the highlight
+    const isScrollingRef = useRef(false);
+    const onFinishScrolling = useDebounceCallback(() => {
+        isScrollingRef.current = false;
 
+        // If the block is in the viewport after the scroll, we need to run the highlight
+        if (isInViewportRef.current) {
+            setIsInViewport(true);
+        }
+    }, 100);
+    useScrollListener(
+        () => {
+            isScrollingRef.current = true;
+            onFinishScrolling();
+        },
+        useRef(typeof window !== 'undefined' ? window : null)
+    );
+
+    // Detect when the block is in viewport
     useInViewportListener(
         blockRef,
         (isInViewport, disconnect) => {
-            // Disconnect once in viewport
-            if (isInViewport) {
-                disconnect();
-                // If it's initially in viewport, we need to run the highlight
-                if (isInViewportRef.current === null) {
-                    runHighlight();
-                }
-            }
             isInViewportRef.current = isInViewport;
+            if (isScrollingRef.current) {
+                // If the user is scrolling, we don't want to run the highlight
+                // because it will be run when the scroll is finished
+                return;
+            }
+
+            if (isInViewport) {
+                // Disconnect once in viewport
+                disconnect();
+                setIsInViewport(true);
+            }
         },
         { rootMargin: '200px' }
     );
 
-    const handleScroll = useDebounceCallback(() => {
-        if (isInViewportRef.current) {
-            debouncedRunHighlight();
+    // When the block is visible or updated, we need to re-run the highlight
+    useEffect(() => {
+        if (isInViewport) {
+            // If the block is in viewport, we need to run the highlight
+            let cancelled = false;
+
+            if (typeof window !== 'undefined') {
+                import('./highlight').then(({ highlight }) => {
+                    highlight(block, inlines).then((lines) => {
+                        if (cancelled) {
+                            return;
+                        }
+
+                        setLines(lines);
+                    });
+                });
+            }
+
+            return () => {
+                cancelled = true;
+            };
         }
-    }, 80);
 
-    useScrollListener(handleScroll, useRef(typeof window !== 'undefined' ? window : null));
+        // Otherwise if the block is not in viewport, we reset to the plain lines
+        setLines(null);
+    }, [isInViewport, block, inlines]);
 
-    return <CodeBlockRenderer ref={blockRef} block={block} style={style} lines={lines} />;
+    return (
+        <CodeBlockRenderer ref={blockRef} block={block} style={style} lines={lines ?? plainLines} />
+    );
 }

packages/gitbook/src/components/DocumentView/CodeBlock/highlight.test.ts

@@ -46,7 +46,7 @@ it('should parse plain code', async () => {
 
 it('should parse different code in parallel', async () => {
     await Promise.all(
-        ['shell', 'scss', 'markdown', 'less', 'scss', 'css', 'scss', 'yaml'].map(async (syntax) =>
+        ['shell', 'scss', 'scss', 'css', 'scss', 'yaml'].map(async (syntax) =>
             highlight(
                 {
                     object: 'block',

packages/gitbook/src/components/DocumentView/CodeBlock/highlight.ts

@@ -35,14 +35,11 @@ export type RenderedInline = {
 
 const theme = createCssVariablesTheme();
 
-const highlighter = createSingletonShorthands(
+const { getSingletonHighlighter } = createSingletonShorthands(
     createdBundledHighlighter<any, any>({
         langs: bundledLanguages,
         themes: {},
-        engine: () =>
-            createJavaScriptRegexEngine({
-                forgiving: true,
-            }),
+        engine: () => createJavaScriptRegexEngine({ forgiving: true, target: 'ES2018' }),
     })
 );
 
@@ -52,7 +49,7 @@ const highlighter = createSingletonShorthands(
 export async function preloadHighlight(block: DocumentBlockCode) {
     const langName = getBlockLang(block);
     if (langName) {
-        await highlighter.getSingletonHighlighter({
+        await getSingletonHighlighter({
             langs: [langName],
             themes: [theme],
         });
@@ -74,7 +71,12 @@ export async function highlight(
 
     const code = getPlainCodeBlock(block);
 
-    const lines = await highlighter.codeToTokensBase(code, {
+    const highlighter = await getSingletonHighlighter({
+        langs: [langName],
+        themes: [theme],
+    });
+
+    const lines = highlighter.codeToTokensBase(code, {
         lang: langName,
         theme,
         tokenizeMaxLineLength: 400,
@@ -132,12 +134,6 @@ function getLanguageForSyntax(syntax: string): BundledLanguage | null {
     // Normalize the syntax to lowercase.
     syntax = syntax.toLowerCase();
 
-    // Temporary disable highlighting for C/C++ code blocks
-    // @see https://github.com/shikijs/shiki/issues/893
-    if (syntax === 'cpp' || syntax === 'c') {
-        return null;
-    }
-
     // Check if the syntax is a bundled language.
     if (checkIsBundledLanguage(syntax)) {
         return syntax;

packages/gitbook/src/components/DocumentView/DocumentView.tsx

@@ -46,9 +46,12 @@ export function DocumentView(
 
         /** Style passed to all blocks */
         blockStyle?: ClassValue;
+
+        /** True if the document should be considered offscreen */
+        isOffscreen?: boolean;
     }
 ) {
-    const { document, style, blockStyle = [], context } = props;
+    const { document, style, blockStyle = [], context, isOffscreen = false } = props;
 
     return (
         <Blocks
@@ -62,6 +65,7 @@ export function DocumentView(
                 'whitespace-pre-wrap',
             ]}
             context={context}
+            isOffscreen={isOffscreen}
         />
     );
 }

packages/gitbook/src/components/DocumentView/Hint.tsx

@@ -104,8 +104,8 @@ const HINT_STYLES: {
             '[&_.can-override-text]:text-neutral-strong',
         ],
         container:
-            'bg-neutral theme-muted:bg-neutral-base theme-bold-tint:bg-neutral-base theme-gradient:bg-neutral-12/1 border-neutral',
-        containerWithHeader: 'border-info-solid bg-neutral-subtle theme-gradient:bg-neutral-12/1',
+            'bg-info border-info theme-muted-tint:bg-info-solid/2 theme-bold-tint:bg-info-solid/2',
+        containerWithHeader: 'border-info-solid bg-info-subtle',
     },
     warning: {
         icon: 'circle-exclamation',
@@ -113,11 +113,13 @@ const HINT_STYLES: {
         header: 'bg-warning-active',
         body: [
             'text-neutral-strong',
-            '[&_a]:text-warning',
-            '[&_a:hover]:text-warning-strong',
+            'links-default:[&_a]:text-warning',
+            'links-default:[&_a:hover]:text-warning-strong',
+            'links-default:[&_a]:decoration-warning/6',
+            'links-accent:[&_a]:decoration-warning',
+            'decoration-warning/6',
             '[&_.can-override-bg]:bg-warning-active',
             '[&_.can-override-text]:text-warning-strong',
-            'decoration-warning/6',
         ],
         container: 'bg-warning border-warning',
         containerWithHeader: 'border-warning-solid bg-warning-subtle',
@@ -128,11 +130,13 @@ const HINT_STYLES: {
         header: 'bg-danger-active',
         body: [
             'text-neutral-strong',
-            '[&_a]:text-danger',
-            '[&_a:hover]:text-danger-strong',
+            'links-default:[&_a]:text-danger',
+            'links-default:[&_a:hover]:text-danger-strong',
+            'links-default:[&_a]:decoration-danger/6',
+            'links-accent:[&_a]:decoration-danger',
+            'decoration-danger/6',
             '[&_.can-override-bg]:bg-danger-active',
             '[&_.can-override-text]:text-danger-strong',
-            'decoration-danger/6',
         ],
         container: 'bg-danger border-danger',
         containerWithHeader: 'border-danger-solid bg-danger-subtle',
@@ -143,11 +147,13 @@ const HINT_STYLES: {
         header: 'bg-success-active',
         body: [
             'text-neutral-strong',
-            '[&_a]:text-success',
-            '[&_a:hover]:text-success-strong',
+            'links-default:[&_a]:text-success',
+            'links-default:[&_a:hover]:text-success-strong',
+            'links-default:[&_a]:decoration-success/6',
+            'links-accent:[&_a]:decoration-success',
+            'decoration-success/6',
             '[&_.can-override-bg]:bg-success-active',
             '[&_.can-override-text]:text-success-strong',
-            'decoration-success/6',
         ],
         container: 'bg-success border-success',
         containerWithHeader: 'border-success-solid bg-success-subtle',

packages/gitbook/src/components/DocumentView/OpenAPI/OpenAPIOperation.tsx

@@ -1,6 +1,6 @@
 import type { JSONDocument } from '@gitbook/api';
 import { Icon } from '@gitbook/icons';
-import { OpenAPIOperation } from '@gitbook/react-openapi';
+import { OpenAPIOperation as BaseOpenAPIOperation } from '@gitbook/react-openapi';
 
 import { resolveOpenAPIOperationBlock } from '@/lib/openapi/resolveOpenAPIOperationBlock';
 import { tcls } from '@/lib/tailwind';
@@ -12,21 +12,21 @@ import { Heading } from '../Heading';
 
 import './scalar.css';
 import './style.css';
-import type { AnyOpenAPIBlock } from '@/lib/openapi/types';
+import type { AnyOpenAPIOperationsBlock } from '@/lib/openapi/types';
 
 /**
  * Render an openapi block or an openapi-operation block.
  */
-export async function OpenAPI(props: BlockProps<AnyOpenAPIBlock>) {
+export async function OpenAPIOperation(props: BlockProps<AnyOpenAPIOperationsBlock>) {
     const { style } = props;
     return (
         <div className={tcls('flex w-full', style, 'max-w-full')}>
-            <OpenAPIBody {...props} />
+            <OpenAPIOperationBody {...props} />
         </div>
     );
 }
 
-async function OpenAPIBody(props: BlockProps<AnyOpenAPIBlock>) {
+async function OpenAPIOperationBody(props: BlockProps<AnyOpenAPIOperationsBlock>) {
     const { block, context } = props;
 
     if (!context.contentContext) {
@@ -53,7 +53,7 @@ async function OpenAPIBody(props: BlockProps<AnyOpenAPIBlock>) {
     }
 
     return (
-        <OpenAPIOperation
+        <BaseOpenAPIOperation
             data={data}
             context={{
                 specUrl,

packages/gitbook/src/components/DocumentView/OpenAPI/OpenAPISchemas.tsx

@@ -0,0 +1,67 @@
+import { resolveOpenAPISchemasBlock } from '@/lib/openapi/resolveOpenAPISchemasBlock';
+import { tcls } from '@/lib/tailwind';
+import { Icon } from '@gitbook/icons';
+import { OpenAPISchemas as BaseOpenAPISchemas } from '@gitbook/react-openapi';
+
+import type { BlockProps } from '../Block';
+
+import './scalar.css';
+import './style.css';
+import type { OpenAPISchemasBlock } from '@/lib/openapi/types';
+
+/**
+ * Render an openapi-schemas block.
+ */
+export async function OpenAPISchemas(props: BlockProps<OpenAPISchemasBlock>) {
+    const { style } = props;
+    return (
+        <div className={tcls('flex w-full', style, 'max-w-full')}>
+            <OpenAPISchemasBody {...props} />
+        </div>
+    );
+}
+
+async function OpenAPISchemasBody(props: BlockProps<OpenAPISchemasBlock>) {
+    const { block, context } = props;
+
+    if (!context.contentContext) {
+        return null;
+    }
+
+    const { data, specUrl, error } = await resolveOpenAPISchemasBlock({
+        block,
+        context: context.contentContext,
+    });
+
+    if (error) {
+        return (
+            <div className="hidden">
+                <p>
+                    Error with {specUrl}: {error.message}
+                </p>
+            </div>
+        );
+    }
+
+    if (!data || !specUrl) {
+        return null;
+    }
+
+    return (
+        <BaseOpenAPISchemas
+            data={data}
+            context={{
+                specUrl,
+                icons: {
+                    chevronDown: <Icon icon="chevron-down" />,
+                    chevronRight: <Icon icon="chevron-right" />,
+                    plus: <Icon icon="plus" />,
+                },
+                defaultInteractiveOpened: context.mode === 'print',
+                id: block.meta?.id,
+                blockKey: block.key,
+            }}
+            className="openapi-block"
+        />
+    );
+}

packages/gitbook/src/components/DocumentView/OpenAPI/index.ts

@@ -1 +1,2 @@
-export * from './OpenAPI';
+export * from './OpenAPIOperation';
+export * from './OpenAPISchemas';

packages/gitbook/src/components/DocumentView/OpenAPI/scalar.css

@@ -264,14 +264,18 @@
     gap: 6px;
 }
 .scalar-activate-button {
-    @apply flex gap-1.5 items-center;
+    @apply flex gap-2 items-center;
     @apply bg-primary-solid text-contrast-primary-solid hover:bg-primary-solid-hover hover:text-contrast-primary-solid-hover contrast-more:ring-1 rounded-md straight-corners:rounded-none place-self-start;
     @apply ring-1 ring-tint hover:ring-tint-hover;
     @apply shadow-sm shadow-tint dark:shadow-tint-1 hover:shadow-md active:shadow-none;
     @apply contrast-more:ring-tint-12 contrast-more:hover:ring-2 contrast-more:hover:ring-tint-12;
     @apply hover:scale-105 active:scale-100 transition-all;
     @apply grow-0 shrink-0 truncate;
-    @apply text-sm px-2.5 py-1;
+    @apply text-[13px] px-2 py-0.5 font-mono font-medium [word-spacing:-2px];
+}
+
+.scalar-activate-button svg {
+    @apply size-2.5;
 }
 
 .scalar-app-loading {

packages/gitbook/src/components/DocumentView/OpenAPI/style.css

@@ -1,9 +1,9 @@
 /* Layout Components */
 .openapi-operation {
-    @apply flex-1 flex flex-col gap-4 mb-14;
+    @apply flex-1 flex flex-col gap-8 mb-14;
 }
 
-.openapi-models {
+.openapi-schemas {
     @apply flex flex-col mb-14 flex-1;
 }
 
@@ -17,7 +17,7 @@
 }
 
 .openapi-summary {
-    @apply flex flex-col items-start justify-start gap-2;
+    @apply flex flex-col items-start justify-start gap-3;
 }
 
 .openapi-deprecated {
@@ -122,7 +122,7 @@
 }
 
 .openapi-column-preview-body {
-    @apply flex flex-col gap-4 sticky top-4 site-header:top-20 site-header-sections:top-32 page-api-block:xl:max-2xl:top-32 print-mode:static;
+    @apply flex flex-col gap-4 sticky top-4 site-header:top-20 site-header-sections:page-has-toc:top-32 page-api-block:xl:max-2xl:top-32 print-mode:static;
 }
 
 .openapi-column-preview pre {
@@ -198,7 +198,11 @@
 }
 
 .openapi-schema-required {
-    @apply text-amber-600 text-[0.813rem];
+    @apply text-warning-subtle text-[0.813rem];
+}
+
+.openapi-schema-readonly {
+    @apply text-primary-subtle/9 text-[0.813rem];
 }
 
 .openapi-schema-type {
@@ -387,17 +391,30 @@
     @apply flex flex-row items-center h-fit;
 }
 
+.openapi-codesample-footer {
+    @apply flex w-full justify-end;
+}
+
 /* Path */
 .openapi-path {
-    @apply flex items-center bg-tint-base text-sm gap-2 p-2 border rounded-md border-tint-subtle;
+    @apply flex items-center text-sm gap-2 h-fit;
+}
+
+.openapi-path-variable {
+    @apply p-px min-w-[1.625rem] text-tint-strong font-normal w-fit justify-center items-center ring-1 ring-inset ring-tint bg-tint rounded text-sm leading-none before:!content-none after:!content-none;
+}
+
+.openapi-path-server {
+    @apply text-tint hidden md:inline;
 }
 
 .openapi-path .openapi-method {
-    @apply text-[0.813rem] m-0 px-1;
+    @apply text-[0.813rem] m-0 h-full items-center flex px-2;
 }
 
 .openapi-path-title {
-    @apply flex-1 relative font-normal whitespace-nowrap overflow-x-auto font-mono text-tint-strong;
+    @apply flex-1 relative font-normal whitespace-nowrap overflow-x-auto font-mono text-tint-strong/10;
+    @apply py-0.5 px-1 rounded hover:bg-tint cursor-pointer transition-colors;
     scrollbar-width: none;
     -ms-overflow-style: none;
 }
@@ -516,6 +533,10 @@
     @apply px-3 py-2 pt-2.5 border-t border-tint-subtle text-[0.813rem] text-tint;
 }
 
+.openapi-tabs-footer .openapi-markdown {
+    @apply text-[0.813rem] text-tint;
+}
+
 /* Disclosure group */
 .openapi-disclosure-group {
     @apply border-b border-tint-subtle relative;
@@ -620,10 +641,44 @@
     @apply space-y-2.5;
 }
 
-.openapi-section-models {
+.openapi-section-schemas {
     @apply border border-tint-subtle rounded-lg;
 }
 
-.openapi-section-models > .openapi-section-body > .openapi-schema-properties > .openapi-schema {
+.openapi-section-schemas > .openapi-section-body > .openapi-schema-properties > .openapi-schema {
     @apply p-2.5;
 }
+
+.openapi-tooltip {
+    @apply flex items-center gap-1 bg-tint-base border border-tint-subtle text-tint-strong rounded-md font-medium px-1.5 py-0.5 shadow-sm text-[13px];
+}
+
+.openapi-tooltip svg {
+    @apply size-3 text-tint-strong;
+}
+
+.openapi-tooltip[data-entering] {
+    animation: tooltip-enter 0.2s ease-in-out forwards;
+}
+
+.openapi-tooltip[data-exiting] {
+    animation: tooltip-leave 0.2s ease-in-out forwards;
+}
+
+@keyframes tooltip-enter {
+    0% {
+        opacity: 0;
+    }
+    100% {
+        opacity: 1;
+    }
+}
+
+@keyframes tooltip-leave {
+    0% {
+        opacity: 1;
+    }
+    100% {
+        opacity: 0;
+    }
+}

packages/gitbook/src/components/Footer/Footer.tsx

@@ -16,25 +16,20 @@ export function Footer(props: { context: GitBookSiteContext }) {
     const { customization } = context;
 
     return (
-        <>
-            <hr className="border-tint-subtle border-t" />
+        <footer
+            className={tcls(
+                'border-tint-subtle border-t',
+                // If the footer only contains a mode toggle, we only show it on smaller screens
+                customization.themes.toggeable &&
+                    !customization.footer.copyright &&
+                    !customization.footer.logo &&
+                    customization.footer.groups?.length === 0
+                    ? 'xl:hidden'
+                    : null
+            )}
+        >
             <div className="scroll-nojump">
-                <footer
-                    className={tcls(
-                        CONTAINER_STYLE,
-                        'px-4',
-                        'mx-auto',
-                        'flex',
-                        'gap-12',
-                        // If the footer only contains a mode toggle, we only show it on smaller screens
-                        customization.themes.toggeable &&
-                            !customization.footer.copyright &&
-                            !customization.footer.logo &&
-                            customization.footer.groups?.length === 0
-                            ? 'xl:hidden'
-                            : null
-                    )}
-                >
+                <div className={tcls(CONTAINER_STYLE, 'px-4', 'mx-auto', 'flex', 'gap-12')}>
                     <div className="hidden page-no-toc:hidden basis-72 lg:block" />
                     <div
                         className={tcls(
@@ -137,8 +132,8 @@ export function Footer(props: { context: GitBookSiteContext }) {
                         </div>
                     </div>
                     <div className="hidden page-no-toc:hidden lg:block xl:basis-56" />
-                </footer>
+                </div>
             </div>
-        </>
+        </footer>
     );
 }

packages/gitbook/src/components/Header/Dropdown.tsx

@@ -44,7 +44,6 @@ export function Dropdown<E extends HTMLElement>(props: {
                     'absolute',
                     'top-full',
                     'left-0',
-                    'z-20',
                     'origin-top-left',
                     'invisible',
                     'transition-opacity',
@@ -54,22 +53,24 @@ export function Dropdown<E extends HTMLElement>(props: {
                     className
                 )}
             >
-                <div
-                    className={tcls(
-                        'mt-2',
-                        'w-full',
-                        'bg-tint-base',
-                        'rounded-lg',
-                        'straight-corners:rounded-sm',
-                        'p-2',
-                        'shadow-1xs',
-                        'overflow-auto',
-                        'ring-1',
-                        'ring-tint-subtle',
-                        'focus:outline-none'
-                    )}
-                >
-                    {children}
+                <div className="fixed z-50 w-52">
+                    <div
+                        className={tcls(
+                            'mt-2',
+                            'w-full',
+                            'bg-tint-base',
+                            'rounded-lg',
+                            'straight-corners:rounded-sm',
+                            'p-2',
+                            'shadow-1xs',
+                            'overflow-auto',
+                            'ring-1',
+                            'ring-tint-subtle',
+                            'focus:outline-none'
+                        )}
+                    >
+                        {children}
+                    </div>
                 </div>
             </div>
         </div>

packages/gitbook/src/components/Header/Header.tsx

@@ -20,7 +20,6 @@ import { SpacesDropdown } from './SpacesDropdown';
 export function Header(props: { context: GitBookSiteContext; withTopHeader?: boolean }) {
     const { context, withTopHeader } = props;
     const { siteSpace, siteSpaces, sections, customization } = context;
-    const isMultiVariants = siteSpaces.length > 1;
 
     return (
         <header
@@ -31,7 +30,7 @@ export function Header(props: { context: GitBookSiteContext; withTopHeader?: boo
                 `h-[${HEADER_HEIGHT_DESKTOP}px]`,
                 'sticky',
                 'top-0',
-                'z-10',
+                'z-30',
                 'w-full',
                 'flex-none',
                 'shadow-[0px_1px_0px]',
@@ -56,11 +55,11 @@ export function Header(props: { context: GitBookSiteContext; withTopHeader?: boo
                     'theme-bold:shadow-tint-12/2'
                 )}
             >
-                <div className={tcls('scroll-nojump')}>
+                <div className="scroll-nojump">
                     <div
                         className={tcls(
                             'gap-4',
-                            'lg:gap-8',
+                            'lg:gap-6',
                             'flex',
                             'items-center',
                             'justify-between',
@@ -68,14 +67,12 @@ export function Header(props: { context: GitBookSiteContext; withTopHeader?: boo
                             'py-3',
                             'min-h-16',
                             'sm:h-16',
-                            isMultiVariants && 'page-no-toc:max-[400px]:flex-wrap',
                             CONTAINER_STYLE
                         )}
                     >
                         <div
                             className={tcls(
-                                'flex max-w-full',
-                                isMultiVariants && 'page-no-toc:max-[400px]:w-full',
+                                'flex max-w-full lg:basis-72',
                                 'min-w-0 shrink items-center justify-start gap-2 lg:gap-4'
                             )}
                         >
@@ -86,44 +83,35 @@ export function Header(props: { context: GitBookSiteContext; withTopHeader?: boo
                                     'text-tint-strong',
                                     'theme-bold:text-header-link',
                                     'hover:bg-tint-hover',
-                                    'theme-bold:hover:bg-header-link/3'
+                                    'theme-bold:hover:bg-header-link/3',
+                                    'page-no-toc:hidden'
                                 )}
                             />
                             <HeaderLogo context={context} />
                         </div>
 
-                        {isMultiVariants && (
-                            <div className="mr-auto page-no-toc:flex hidden">
-                                <SpacesDropdown
-                                    context={context}
-                                    siteSpace={siteSpace}
-                                    siteSpaces={siteSpaces}
-                                    className={
-                                        'theme-bold:bg-header-link/2 theme-bold:text-header-link theme-bold:ring-header-link/4 theme-bold:group-focus-within/dropdown:bg-header-link/3 theme-bold:group-focus-within/dropdown:text-header-link theme-bold:group-focus-within/dropdown:ring-header-link/6 theme-bold:group-hover/dropdown:bg-header-link/3 theme-bold:group-hover/dropdown:text-header-link theme-bold:group-hover/dropdown:ring-header-link/6 theme-bold:contrast-more:bg-header-background theme-bold:contrast-more:text-header-link theme-bold:contrast-more:ring-header-link theme-bold:contrast-more:group-hover/dropdown:text-header-link theme-bold:contrast-more:group-hover/dropdown:ring-header-link theme-bold:contrast-more:group-focus-within/dropdown:text-header-link theme-bold:contrast-more:group-focus-within/dropdown:ring-header-link theme-bold:dark:bg-header-link/2 theme-bold:dark:text-header-link theme-bold:dark:ring-header-link/4 theme-bold:dark:group-hover/dropdown:bg-header-link/3 theme-bold:dark:group-hover/dropdown:text-header-link theme-bold:dark:group-hover/dropdown:ring-header-link/6 theme-bold:contrast-more:dark:group-hover/dropdown:text-header-link theme-bold:contrast-more:dark:group-hover/dropdown:ring-header-link theme-bold:dark:group-focus-within/dropdown:bg-header-link/3 theme-bold:dark:group-focus-within/dropdown:text-header-link theme-bold:dark:group-focus-within/dropdown:ring-header-link/6 theme-bold:contrast-more:dark:group-focus-within/dropdown:text-header-link theme-bold:contrast-more:dark:group-focus-within/dropdown:ring-header-link'
-                                    }
-                                />
-                            </div>
-                        )}
-
-                        {customization.header.links.length > 0 && (
-                            <HeaderLinks>
-                                {customization.header.links.map((link, index) => {
-                                    return <HeaderLink key={index} link={link} context={context} />;
-                                })}
-                                <HeaderLinkMore
-                                    label={t(getSpaceLanguage(customization), 'more')}
-                                    links={customization.header.links}
-                                    context={context}
-                                />
-                            </HeaderLinks>
-                        )}
                         <div
                             className={tcls(
                                 'flex',
-                                'md:min-w-56',
                                 'grow-0',
                                 'shrink-0',
-                                'justify-self-end'
+                                'md:basis-56',
+                                'justify-self-end',
+                                'search' in customization.styling &&
+                                    customization.styling.search === 'prominent'
+                                    ? [
+                                          'md:grow-[0.8]',
+                                          'lg:basis-40',
+                                          'max-w-lg',
+                                          'lg:ml-[max(calc((100%-18rem-48rem-3rem)/2),1.5rem)]', // container (100%) - sidebar (18rem) - content (48rem) - margin (3rem)
+                                          'xl:ml-[max(calc((100%-18rem-48rem-14rem-3rem)/2),1.5rem)]', // container (100%) - sidebar (18rem) - content (48rem) - outline (14rem) - margin (3rem)
+                                          'page-no-toc:lg:ml-[max(calc((100%-18rem-48rem-18rem-3rem)/2),0rem)]',
+                                          'page-full-width:lg:ml-6',
+                                          'lg:mr-auto',
+                                          'order-last',
+                                          'md:order-[unset]',
+                                      ]
+                                    : ['order-last']
                             )}
                         >
                             <Suspense fallback={null}>
@@ -152,6 +140,7 @@ export function Header(props: { context: GitBookSiteContext; withTopHeader?: boo
 
                                         'theme-bold:shadow-none',
                                         'theme-bold:hover:shadow-none',
+                                        'whitespace-nowrap',
                                     ]}
                                 >
                                     <span className={tcls('flex-1')}>
@@ -166,11 +155,70 @@ export function Header(props: { context: GitBookSiteContext; withTopHeader?: boo
                                 </SearchButton>
                             </Suspense>
                         </div>
+
+                        {customization.header.links.length > 0 && (
+                            <HeaderLinks>
+                                {customization.header.links.map((link) => {
+                                    return (
+                                        <HeaderLink
+                                            key={link.title}
+                                            link={link}
+                                            context={context}
+                                        />
+                                    );
+                                })}
+                                <HeaderLinkMore
+                                    label={t(getSpaceLanguage(customization), 'more')}
+                                    links={customization.header.links}
+                                    context={context}
+                                />
+                            </HeaderLinks>
+                        )}
                     </div>
                 </div>
             </div>
-            {sections ? (
-                <SiteSectionTabs sections={encodeClientSiteSections(context, sections)} />
+
+            {sections || siteSpaces.length > 1 ? (
+                <div
+                    className={tcls(
+                        'w-full',
+                        'overflow-x-scroll',
+                        'overflow-y-hidden',
+                        'hide-scroll',
+                        '-mb-4 pb-4', // Positive padding / negative margin allows the navigation menu indicator to show in a scroll viewƒ
+                        !sections ? ['hidden', 'page-no-toc:flex'] : 'flex'
+                    )}
+                >
+                    <div
+                        className={tcls(
+                            CONTAINER_STYLE,
+                            'page-default-width:max-w-[unset]',
+                            'grow',
+                            'flex',
+                            'items-end',
+                            'page-default-width:2xl:px-[calc((100%-1536px+4rem)/2)]'
+                        )}
+                    >
+                        {siteSpaces.length > 1 && (
+                            <div
+                                id="variants"
+                                className="my-2 mr-5 page-no-toc:flex hidden grow border-tint border-r pr-5 *:grow only:mr-0 only:border-none only:pr-0 sm:max-w-64"
+                            >
+                                <SpacesDropdown
+                                    context={context}
+                                    siteSpace={siteSpace}
+                                    siteSpaces={siteSpaces}
+                                    className="w-full grow py-1"
+                                />
+                            </div>
+                        )}
+                        {sections && (
+                            <SiteSectionTabs
+                                sections={encodeClientSiteSections(context, sections)}
+                            />
+                        )}
+                    </div>
+                </div>
             ) : null}
         </header>
     );

packages/gitbook/src/components/Header/HeaderLink.tsx

@@ -34,7 +34,7 @@ export async function HeaderLink(props: {
     if (link.links && link.links.length > 0) {
         return (
             <Dropdown
-                className="shrink"
+                className={`shrink ${customization.styling.search === 'prominent' ? 'right-0 left-auto' : null}`}
                 button={(buttonProps) => {
                     if (!target || !link.to) {
                         return (
@@ -151,8 +151,8 @@ function HeaderItemButton(
 
 function getHeaderLinkClassName(_props: { headerPreset: CustomizationHeaderPreset }) {
     return tcls(
-        'flex items-center shrink',
-        'min-w-0',
+        'flex items-center',
+        'shrink',
         'contrast-more:underline',
         'truncate',
 

packages/gitbook/src/components/Header/HeaderLinkMore.tsx

@@ -45,7 +45,13 @@ export function HeaderLinkMore(props: {
 
     return (
         <div className={`${styles.linkEllipsis} z-20 items-center`}>
-            <Dropdown button={renderButton} className="-translate-x-48 md:translate-x-0">
+            <Dropdown
+                button={renderButton}
+                className={tcls(
+                    'max-md:right-0 max-md:left-auto',
+                    context.customization.styling.search === 'prominent' && 'right-0 left-auto'
+                )}
+            >
                 <DropdownMenu>
                     {links.map((link, index) => (
                         <MoreMenuLink key={index} link={link} context={context} />

packages/gitbook/src/components/Header/HeaderLinks.tsx

@@ -1,19 +1,21 @@
 import type React from 'react';
 
-import { tcls } from '@/lib/tailwind';
+import { type ClassValue, tcls } from '@/lib/tailwind';
 
 import styles from './headerLinks.module.css';
 
 interface HeaderLinksProps {
     children: React.ReactNode;
+    style?: ClassValue;
 }
 
-export async function HeaderLinks({ children }: HeaderLinksProps) {
+export async function HeaderLinks({ children, style }: HeaderLinksProps) {
     return (
         <div
             className={tcls(
                 styles.containerHeaderlinks,
-                'lg:[&>.button+.button]:-ml-2 z-20 flex min-w-9 shrink grow items-center justify-end gap-x-4 lg:gap-x-6'
+                'lg:[&>.button+.button]:-ml-2 z-20 ml-auto flex min-w-9 shrink grow items-center justify-end gap-x-4 lg:gap-x-6 xl:grow-0',
+                style
             )}
         >
             {children}

packages/gitbook/src/components/Header/HeaderLogo.tsx

@@ -55,6 +55,7 @@ export async function HeaderLogo(props: HeaderLogoProps) {
                         'min-w-0',
                         'max-w-40',
                         'lg:max-w-64',
+                        'site-header-none:page-no-toc:lg:max-w-56',
                         'max-h-10',
                         'lg:max-h-12',
                         'h-full',
@@ -84,7 +85,7 @@ function LogoFallback(props: HeaderLogoProps) {
             <div
                 className={tcls(
                     'text-pretty',
-                    'line-clamp-3',
+                    'line-clamp-2',
                     'tracking-tight',
                     'max-w-[18ch]',
                     'lg:max-w-[24ch]',

packages/gitbook/src/components/Header/HeaderMobileMenu.tsx

@@ -54,7 +54,6 @@ export function HeaderMobileMenu(props: Partial<React.ButtonHTMLAttributes<HTMLB
                 'px-2',
                 'rounded',
                 'straight-corners:rounded-sm',
-                'page-no-toc:hidden',
                 props.className
             )}
         >

packages/gitbook/src/components/Header/SpacesDropdown.tsx

@@ -63,7 +63,7 @@ export function SpacesDropdown(props: {
                         className
                     )}
                 >
-                    <span className={tcls('line-clamp-2', 'grow')}>{siteSpace.title}</span>
+                    <span className={tcls('truncate', 'grow')}>{siteSpace.title}</span>
                     <DropdownChevron />
                 </div>
             )}

packages/gitbook/src/components/Header/headerLinks.module.css

@@ -1,6 +1,8 @@
-.containerHeaderlinks {
-    container-type: inline-size;
-    container-name: headerlinks;
+@media (max-width: 1279px) {
+    .containerHeaderlinks {
+        container-type: inline-size;
+        container-name: headerlinks;
+    }
 }
 
 .linkEllipsis {
@@ -43,7 +45,7 @@
         }
     }
 }
-@container headerlinks (width < 600px) {
+@container headerlinks (width < 550px) {
     .containerHeaderlinks > :nth-child(n + 4) {
         display: none;
     }
@@ -54,7 +56,7 @@
         }
     }
 }
-@container headerlinks (width < 750px) {
+@container headerlinks (width < 650px) {
     .containerHeaderlinks > :nth-child(n + 5) {
         display: none;
     }
@@ -65,7 +67,7 @@
         }
     }
 }
-@container headerlinks (width < 850px) {
+@container headerlinks (width < 750px) {
     .containerHeaderlinks > :nth-child(n + 6) {
         display: none;
     }

packages/gitbook/src/components/Insights/InsightsProvider.tsx

@@ -63,6 +63,7 @@ const InsightsContext = React.createContext<TrackEventCallback>(() => {});
 
 interface InsightsProviderProps extends InsightsEventContext {
     enabled: boolean;
+    appURL: string;
     apiHost: string;
     visitorAuthToken: string | null;
     children: React.ReactNode;
@@ -72,7 +73,7 @@ interface InsightsProviderProps extends InsightsEventContext {
  * Wrap the content of the app with the InsightsProvider to track events.
  */
 export function InsightsProvider(props: InsightsProviderProps) {
-    const { enabled, apiHost, visitorAuthToken, children, ...context } = props;
+    const { enabled, appURL, apiHost, visitorAuthToken, children, ...context } = props;
 
     const visitorIdRef = React.useRef<string | null>(null);
     const eventsRef = React.useRef<{
@@ -140,7 +141,7 @@ export function InsightsProvider(props: InsightsProviderProps) {
     });
 
     const flushBatchedEvents = useDebounceCallback(async () => {
-        const visitorId = visitorIdRef.current ?? (await getVisitorId());
+        const visitorId = visitorIdRef.current ?? (await getVisitorId(appURL));
         visitorIdRef.current = visitorId;
 
         flushEventsSync();
@@ -184,7 +185,7 @@ export function InsightsProvider(props: InsightsProviderProps) {
      * Get the visitor ID and store it in a ref.
      */
     React.useEffect(() => {
-        getVisitorId().then((visitorId) => {
+        getVisitorId(appURL).then((visitorId) => {
             visitorIdRef.current = visitorId;
             // When the page is unloaded, flush all events, but only if the visitor ID is set
             window.addEventListener('beforeunload', flushEventsSync);
@@ -192,7 +193,7 @@ export function InsightsProvider(props: InsightsProviderProps) {
         return () => {
             window.removeEventListener('beforeunload', flushEventsSync);
         };
-    }, [flushEventsSync]);
+    }, [flushEventsSync, appURL]);
 
     return (
         <InsightsContext.Provider value={trackEvent}>

packages/gitbook/src/components/Insights/visitorId.ts

@@ -13,10 +13,10 @@ let pendingVisitorId: Promise<string> | null = null;
 /**
  * Return the current visitor identifier.
  */
-export async function getVisitorId(): Promise<string> {
+export async function getVisitorId(appURL: string): Promise<string> {
     if (!visitorId) {
         if (!pendingVisitorId) {
-            pendingVisitorId = fetchVisitorID().finally(() => {
+            pendingVisitorId = fetchVisitorID(appURL).finally(() => {
                 pendingVisitorId = null;
             });
         }
@@ -30,7 +30,7 @@ export async function getVisitorId(): Promise<string> {
 /**
  * Propose a visitor identifier to the GitBook.com server and get the devideId back.
  */
-async function fetchVisitorID(): Promise<string> {
+async function fetchVisitorID(appURL: string): Promise<string> {
     const withoutCookies = isCookiesTrackingDisabled();
 
     if (withoutCookies) {
@@ -46,7 +46,7 @@ async function fetchVisitorID(): Promise<string> {
     // No tracking deviceId set, we'll need to consolidate with the server.
     const proposed = generateRandomId();
 
-    const url = new URL(process.env.NEXT_PUBLIC_GITBOOK_APP_URL ?? 'https://app.gitbook.com');
+    const url = new URL(appURL);
     url.pathname = '/__session';
     url.searchParams.set('proposed', proposed);
 

packages/gitbook/src/components/PDF/PDFPage.tsx

@@ -0,0 +1,356 @@
+import {
+    type CustomizationSettings,
+    type Revision,
+    type RevisionPageDocument,
+    type RevisionPageGroup,
+    RevisionPageType,
+    type SiteCustomizationSettings,
+    SiteInsightsTrademarkPlacement,
+    type Space,
+} from '@gitbook/api';
+import { Icon } from '@gitbook/icons';
+import type { GitBookSiteContext, GitBookSpaceContext } from '@v2/lib/context';
+import { getPageDocument } from '@v2/lib/data';
+import type { GitBookSpaceLinker } from '@v2/lib/links';
+import type { Metadata } from 'next';
+import { notFound } from 'next/navigation';
+import * as React from 'react';
+
+import { DocumentView } from '@/components/DocumentView';
+import { TrademarkLink } from '@/components/TableOfContents/Trademark';
+import type { PolymorphicComponentProp } from '@/components/utils/types';
+import { getSpaceLanguage } from '@/intl/server';
+import { tString } from '@/intl/translate';
+import { getPagePDFContainerId } from '@/lib/links';
+import { resolvePageId } from '@/lib/pages';
+import { tcls } from '@/lib/tailwind';
+import { defaultCustomizationForSpace } from '@/lib/utils';
+import { type PDFSearchParams, getPDFSearchParams } from './urls';
+
+import { PageControlButtons } from './PageControlButtons';
+import { PrintButton } from './PrintButton';
+import './pdf.css';
+
+const DEFAULT_LIMIT = 100;
+
+/**
+ * Generate the metadata for the PDF page.
+ */
+export async function generatePDFMetadata(
+    context: GitBookSpaceContext | GitBookSiteContext
+): Promise<Metadata> {
+    return {
+        title: 'site' in context ? context.site.title : context.space.title,
+        robots: 'noindex, nofollow',
+    };
+}
+
+/**
+ * Render a space as a standalone HTML page that can be printed as a PDF.
+ */
+export async function PDFPage(props: {
+    context: GitBookSpaceContext | GitBookSiteContext;
+    searchParams: { [key: string]: string };
+}) {
+    const baseContext = props.context;
+    const searchParams = new URLSearchParams(props.searchParams);
+    const pdfParams = getPDFSearchParams(new URLSearchParams(searchParams));
+
+    const customization =
+        'customization' in baseContext ? baseContext.customization : defaultCustomizationForSpace();
+    const language = getSpaceLanguage(customization);
+
+    // Compute the pages to render
+    const { pages, total } = selectPages(baseContext.pages, pdfParams);
+    const pageIds = pages.map(
+        ({ page }) => [page.id, getPagePDFContainerId(page)] as [string, string]
+    );
+
+    // Build a linker that create anchor links for the pages rendered in the PDF page.
+    const linker: GitBookSpaceLinker = {
+        ...baseContext.linker,
+        toPathForPage(input) {
+            if (pages.some((p) => p.page.id === input.page.id)) {
+                return `#${getPagePDFContainerId(input.page, input.anchor)}`;
+            }
+            if (input.page.type === RevisionPageType.Group) {
+                return '#';
+            }
+
+            // Use an absolute URL to the page
+            return input.page.urls.app;
+        },
+    };
+
+    const context: GitBookSpaceContext = {
+        ...baseContext,
+        linker,
+    };
+
+    return (
+        <div className="print-mode">
+            {pdfParams.back !== 'false' ? (
+                <div className={tcls('fixed', 'left-12', 'top-12', 'print:hidden', 'z-50')}>
+                    <a
+                        title={tString(language, 'pdf_goback')}
+                        href={pdfParams.back ?? linker.toAbsoluteURL(linker.toPathInContent(''))}
+                        className={tcls(
+                            'flex',
+                            'flex-row',
+                            'items-center',
+                            'justify-center',
+                            'text-sm',
+                            'text-tint',
+                            'hover:text-primary',
+                            'p-4',
+                            'rounded-full',
+                            'bg-white',
+                            'shadow-sm',
+                            'hover:shadow-md',
+                            'border-slate-300',
+                            'border'
+                        )}
+                    >
+                        <Icon icon="arrow-left" className={tcls('size-6')} />
+                    </a>
+                </div>
+            ) : null}
+
+            <div className={tcls('fixed', 'right-12', 'top-12', 'print:hidden', 'z-50')}>
+                <PrintButton
+                    title={tString(language, 'pdf_print')}
+                    className={tcls(
+                        'flex',
+                        'flex-row',
+                        'items-center',
+                        'justify-center',
+                        'text-sm',
+                        'text-tint',
+                        'hover:text-primary',
+                        'p-4',
+                        'rounded-full',
+                        'bg-white',
+                        'shadow-sm',
+                        'hover:shadow-md',
+                        'border-slate-300',
+                        'border'
+                    )}
+                >
+                    <Icon icon="print" className={tcls('size-6')} />
+                </PrintButton>
+            </div>
+
+            <PageControlButtons
+                params={pdfParams}
+                pageIds={pageIds}
+                total={total}
+                trademark={
+                    customization.trademark.enabled ? (
+                        <TrademarkLink
+                            space={context.space}
+                            customization={customization}
+                            placement={SiteInsightsTrademarkPlacement.Pdf}
+                        />
+                    ) : null
+                }
+            />
+
+            {pdfParams.only ? null : (
+                <PDFSpaceIntro space={context.space} customization={customization} />
+            )}
+            {pages.map(({ page }) =>
+                page.type === 'group' ? (
+                    <PDFPageGroup key={page.id} space={context.space} page={page} />
+                ) : (
+                    <React.Suspense
+                        key={page.id}
+                        fallback={
+                            <PrintPage id={getPagePDFContainerId(page)}>
+                                <p>Loading...</p>
+                            </PrintPage>
+                        }
+                    >
+                        <PDFPageDocument page={page} context={context} />
+                    </React.Suspense>
+                )
+            )}
+        </div>
+    );
+}
+
+async function PDFSpaceIntro(props: {
+    space: Space;
+    customization: CustomizationSettings | SiteCustomizationSettings;
+}) {
+    const { space, customization } = props;
+
+    return (
+        <PrintPage isFirst>
+            <div className={tcls('flex', 'items-center', 'justify-center', 'py-12')}>
+                <h1 className={tcls('text-6xl', 'font-bold')}>
+                    {customization.title ?? space.title}
+                </h1>
+            </div>
+        </PrintPage>
+    );
+}
+
+async function PDFPageGroup(props: { space: Space; page: RevisionPageGroup }) {
+    const { page } = props;
+
+    return (
+        <PrintPage id={getPagePDFContainerId(page)}>
+            <div
+                className={tcls(
+                    'break-before-page',
+                    'mt-10',
+                    'print:mt-0',
+                    'flex',
+                    'items-center',
+                    'justify-center',
+                    'py-12'
+                )}
+            >
+                <h1 className={tcls('text-5xl', 'font-bold')}>{page.title}</h1>
+            </div>
+        </PrintPage>
+    );
+}
+
+async function PDFPageDocument(props: {
+    page: RevisionPageDocument;
+    context: GitBookSpaceContext;
+}) {
+    const { page, context } = props;
+    const { space } = context;
+    const document = await getPageDocument(context.dataFetcher, space, page);
+
+    return (
+        <PrintPage id={getPagePDFContainerId(page)}>
+            <h1 className={tcls('text-4xl', 'font-bold')}>{page.title}</h1>
+            {page.description ? (
+                <p className={tcls('decoration-primary/6', 'mt-2', 'mb-3')}>{page.description}</p>
+            ) : null}
+
+            {document ? (
+                <DocumentView
+                    document={document}
+                    style="mt-6 space-y-6"
+                    blockStyle="max-w-full"
+                    context={{
+                        mode: 'print',
+                        contentContext: {
+                            ...context,
+                            page,
+                        },
+                        getId: (id) => getPagePDFContainerId(page, id),
+                    }}
+                    // We consider all pages as offscreen in PDF mode
+                    // to ensure we can efficiently render as many pages as possible
+                    isOffscreen={true}
+                />
+            ) : null}
+        </PrintPage>
+    );
+}
+
+function PrintPage(
+    props: PolymorphicComponentProp<
+        'div',
+        {
+            isFirst?: boolean;
+        }
+    >
+) {
+    const { children, isFirst, className, ...rest } = props;
+
+    return (
+        <div
+            {...rest}
+            className={tcls(
+                className,
+                'my-11',
+                'print:my-0',
+                'mx-auto',
+                'max-w-4xl',
+                'w-full',
+                'p-12',
+                'print:p-0',
+                'shadow-xl',
+                'print:shadow-none',
+                'rounded-sm',
+                'bg-white',
+                'min-h-[29.7cm]',
+                'print:min-h-0',
+                isFirst ? null : 'break-before-page',
+                'break-anywhere'
+            )}
+        >
+            {children}
+        </div>
+    );
+}
+
+type FlatPageEntry = { page: RevisionPageDocument | RevisionPageGroup; depth: number };
+
+/**
+ * Compute the ordered flat set of pages to render.
+ */
+function selectPages(
+    rootPages: Revision['pages'],
+    params: PDFSearchParams
+): { pages: FlatPageEntry[]; total: number } {
+    const flattenPage = (
+        page: RevisionPageDocument | RevisionPageGroup,
+        depth: number
+    ): FlatPageEntry[] => {
+        return [
+            { page, depth },
+            ...page.pages.flatMap((child) => {
+                if (child.type !== 'document') {
+                    return [];
+                }
+
+                if (child.hidden) {
+                    return [];
+                }
+
+                return flattenPage(child, depth + 1);
+            }),
+        ];
+    };
+
+    const limitTo = (entries: FlatPageEntry[]) => {
+        return {
+            // Apply a soft-limit, the limit can be controlled by the URL to allow testing
+            pages: entries.slice(0, params.limit ?? DEFAULT_LIMIT),
+            total: entries.length,
+        };
+    };
+
+    if (params.page) {
+        const found = resolvePageId(rootPages, params.page);
+        if (!found) {
+            notFound();
+        }
+
+        if (!params.only) {
+            return limitTo([{ page: found.page, depth: 0 }]);
+        }
+
+        return limitTo(flattenPage(found.page, 0));
+    }
+
+    const allPages = rootPages.flatMap((page) => {
+        if (page.type !== 'document' && page.type !== 'group') {
+            return [];
+        }
+
+        if (page.hidden) {
+            return [];
+        }
+
+        return flattenPage(page, 0);
+    });
+    return limitTo(allPages);
+}

packages/gitbook/src/components/PDF/PDFRootLayout.tsx

@@ -0,0 +1,23 @@
+import { CustomizationRootLayout } from '@/components/RootLayout';
+import { defaultCustomizationForSpace } from '@/lib/utils';
+import type { GitBookSiteContext, GitBookSpaceContext } from '@v2/lib/context';
+
+/**
+ * Layout to be used for rendering the PDF.
+ */
+export async function PDFRootLayout(props: {
+    context: GitBookSpaceContext | GitBookSiteContext;
+    children: React.ReactNode;
+}) {
+    const { context, children } = props;
+
+    return (
+        <CustomizationRootLayout
+            customization={
+                'customization' in context ? context.customization : defaultCustomizationForSpace()
+            }
+        >
+            {children}
+        </CustomizationRootLayout>
+    );
+}

packages/gitbook/src/components/PDF/PageControlButtons.tsx

@@ -7,7 +7,7 @@ import { useScrollActiveId } from '@/components/hooks';
 import { Button } from '@/components/primitives';
 import { t, useLanguage } from '@/intl/client';
 import { tcls } from '@/lib/tailwind';
-import { getPDFUrl } from '@/lib/urls';
+import { type PDFSearchParams, getPDFURLSearchParams } from './urls';
 
 const limitExtend = 50;
 
@@ -15,18 +15,15 @@ const limitExtend = 50;
  * Dynamic controls to show active page and to let the user select between modes.
  */
 export function PageControlButtons(props: {
-    pdfHref: string;
-    singlePageMode: boolean;
+    params: PDFSearchParams;
     /** Array of the [pageId, divId] */
     pageIds: Array<[string, string]>;
-    /** Current limit */
-    limit: number;
     /** Total number of pages targetted by the generation */
     total: number;
     /** Trademark to display */
     trademark?: React.ReactNode;
 }) {
-    const { pdfHref, singlePageMode, pageIds, limit, total, trademark } = props;
+    const { params, pageIds, total, trademark } = props;
 
     const language = useLanguage();
 
@@ -53,19 +50,24 @@ export function PageControlButtons(props: {
                     'z-50'
                 )}
             >
-                {singlePageMode ? null : (
+                {params.only ? null : (
                     <Button
-                        href={getPDFUrl(new URL(pdfHref), {
+                        href={`?${getPDFURLSearchParams({
+                            ...params,
                             page: activePageId,
                             only: true,
-                        }).toString()}
+                        }).toString()}`}
                         variant="secondary"
                     >
                         {t(language, 'pdf_mode_only_page')}
                     </Button>
                 )}
                 <Button
-                    href={getPDFUrl(new URL(pdfHref), { page: undefined, only: false }).toString()}
+                    href={`?${getPDFURLSearchParams({
+                        ...params,
+                        page: undefined,
+                        only: false,
+                    }).toString()}`}
                     variant="secondary"
                 >
                     {t(language, 'pdf_mode_all')}
@@ -113,11 +115,12 @@ export function PageControlButtons(props: {
                             <div>{t(language, 'pdf_limit_reached', total, pageIds.length)}</div>
                             <div>
                                 <a
-                                    href={getPDFUrl(new URL(pdfHref), {
+                                    href={`?${getPDFURLSearchParams({
+                                        ...params,
                                         page: undefined,
                                         only: false,
-                                        limit: limit + limitExtend,
-                                    }).toString()}
+                                        limit: params.limit + limitExtend,
+                                    }).toString()}`}
                                     className={tcls('underline')}
                                 >
                                     {t(language, 'pdf_limit_reached_continue', limitExtend)}

packages/gitbook/src/components/PDF/PrintButton.tsx

@@ -12,7 +12,7 @@ export function PrintButton(props: PolymorphicComponentProp<'button'>) {
     }, []);
 
     return (
-        <button {...rest} onClick={onClick} className={className}>
+        <button {...rest} data-testid="print-button" onClick={onClick} className={className}>
             {children}
         </button>
     );

packages/gitbook/src/components/PDF/index.ts

@@ -0,0 +1,3 @@
+export * from './PDFRootLayout';
+export * from './PDFPage';
+export * from './urls';

packages/gitbook/src/components/PDF/urls.ts

@@ -1,10 +1,12 @@
+const DEFAULT_LIMIT = 100;
+
 export interface PDFSearchParams {
     /** Page to export. If none is passed, all pages are exported. */
     page?: string;
     /** If true, only the `page` is exported, and not its descendant */
     only?: boolean;
     /** Limit the number of pages */
-    limit?: number;
+    limit: number;
     /** URL to redirect back to */
     back?: string;
 }
@@ -13,7 +15,9 @@ export interface PDFSearchParams {
  * Get the PDF export params from the URL serch params.
  */
 export function getPDFSearchParams(searchParams: URLSearchParams): PDFSearchParams {
-    const params: PDFSearchParams = {};
+    const params: PDFSearchParams = {
+        limit: DEFAULT_LIMIT,
+    };
 
     if (searchParams.has('page')) {
         params.page = searchParams.get('page') ?? '';
@@ -32,15 +36,9 @@ export function getPDFSearchParams(searchParams: URLSearchParams): PDFSearchPara
 }
 
 /**
- * Update the URL with the PDF export params.
+ * Get the URL search params to use for a PDF export.
  */
-export function getPDFUrl(url: URL, params: PDFSearchParams): URL {
-    const copy = new URL(url);
-    getPDFUrlSearchParams(params, copy.searchParams);
-    return copy;
-}
-
-export function getPDFUrlSearchParams(
+export function getPDFURLSearchParams(
     params: PDFSearchParams,
     searchParams = new URLSearchParams({})
 ): URLSearchParams {

packages/gitbook/src/components/PageAside/PageAside.tsx

@@ -13,9 +13,9 @@ import urlJoin from 'url-join';
 import { getSpaceLanguage, t } from '@/intl/server';
 import { getDocumentSections } from '@/lib/document-sections';
 import { tcls } from '@/lib/tailwind';
-import { getPDFUrlSearchParams } from '@/lib/urls';
 
 import { Ad } from '../Ads';
+import { getPDFURLSearchParams } from '../PDF';
 import { PageFeedbackForm } from '../PageFeedback';
 import { ThemeToggler } from '../ThemeToggler';
 import { ScrollSectionsList } from './ScrollSectionsList';
@@ -36,9 +36,10 @@ export function PageAside(props: {
     const language = getSpaceLanguage(customization);
 
     const pdfHref = context.linker.toPathInContent(
-        `~gitbook/pdf?${getPDFUrlSearchParams({
+        `~gitbook/pdf?${getPDFURLSearchParams({
             page: page.id,
             only: true,
+            limit: 100,
         }).toString()}`
     );
     return (
@@ -47,8 +48,11 @@ export function PageAside(props: {
                 'group/aside',
                 'hidden',
                 'xl:flex',
+                // 'page-no-toc:lg:flex',
                 'flex-col',
                 'basis-56',
+                // 'page-no-toc:basis-40',
+                // 'page-no-toc:xl:basis-56',
                 'grow-0',
                 'shrink-0',
                 'break-anywhere', // To prevent long words in headings from breaking the layout

packages/gitbook/src/components/PageBody/PageBody.tsx

@@ -47,12 +47,12 @@ export function PageBody(props: {
                         'page-api-block:xl:max-2xl:pr-0',
                         // Max size to ensure one column in api is aligned with rest of content (2 x 3xl) + (gap-3 + 2) * px-12
                         'page-api-block:max-w-[1654px]',
-                        'page-api-block:mx-auto',
+                        'page-api-block:mx-auto'
 
-                        page.layout.tableOfContents ? null : 'xl:ml-56'
+                        // page.layout.tableOfContents ? null : 'xl:ml-56'
                     ) +
-                    (asFullWidth ? ' page-full-width' : '') +
-                    (!page.layout.tableOfContents ? ' page-no-toc' : '')
+                    (asFullWidth ? ' page-full-width' : ' page-default-width') +
+                    (!page.layout.tableOfContents ? ' page-no-toc' : ' page-has-toc')
                 }
             >
                 <PreservePageLayout asFullWidth={asFullWidth} />

packages/gitbook/src/components/PageBody/PageCover.tsx

@@ -32,7 +32,11 @@ export async function PageCover(props: {
                           'sm:-mx-6',
                           'md:-mx-8',
                           '-lg:mr-8',
-                          page.layout.tableOfContents ? 'lg:ml-0' : null,
+                          'lg:ml-0',
+                          !page.layout.tableOfContents &&
+                          context.customization.header.preset !== 'none'
+                              ? 'lg:-ml-64'
+                              : null,
                       ]
                     : ['sm:mx-auto', 'max-w-3xl', 'sm:rounded-md', 'mb-8']
             )}

packages/gitbook/src/components/RootLayout/CustomizationRootLayout.tsx

@@ -31,6 +31,7 @@ import { ClientContexts } from './ClientContexts';
 
 import '@gitbook/icons/style.css';
 import './globals.css';
+import { GITBOOK_ICONS_TOKEN, GITBOOK_ICONS_URL } from '@v2/lib/env';
 
 /**
  * Layout shared between the content and the PDF renderer.
@@ -54,7 +55,7 @@ export async function CustomizationRootLayout(props: {
             lang={customization.internationalization.locale}
             className={tcls(
                 customization.header.preset === CustomizationHeaderPreset.None
-                    ? null
+                    ? 'site-header-none'
                     : 'scroll-pt-[76px]', // Take the sticky header in consideration for the scrolling
                 customization.styling.corners === CustomizationCorners.Straight
                     ? ' straight-corners'
@@ -127,8 +128,8 @@ export async function CustomizationRootLayout(props: {
                 )}
             >
                 <IconsProvider
-                    assetsURL={process.env.GITBOOK_ICONS_URL ?? getAssetURL('icons')}
-                    assetsURLToken={process.env.GITBOOK_ICONS_TOKEN}
+                    assetsURL={GITBOOK_ICONS_URL}
+                    assetsURLToken={GITBOOK_ICONS_TOKEN}
                     assetsByStyles={{
                         'custom-icons': {
                             assetsURL: getAssetURL('icons'),

packages/gitbook/src/components/Search/SearchButton.tsx

@@ -43,8 +43,8 @@ export function SearchButton(props: { children?: React.ReactNode; style?: ClassV
                 'justify-center',
                 'items-center',
                 'w-full',
-                'px-3',
                 'py-2',
+                'px-3',
                 'gap-2',
 
                 'bg-tint-base',
@@ -81,10 +81,11 @@ export function SearchButton(props: { children?: React.ReactNode; style?: ClassV
                 'contrast-more:focus:ring-tint-12',
 
                 'active:shadow-sm',
-                'active:scale-98',
+                'active:scale-100',
 
                 'md:justify-start',
                 'md:w-full',
+                'text-sm',
                 style
             )}
         >
@@ -99,7 +100,7 @@ export function SearchButton(props: { children?: React.ReactNode; style?: ClassV
 }
 
 const Shortcut = () => {
-    const [operatingSystem, setOperatingSystem] = useState('win');
+    const [operatingSystem, setOperatingSystem] = useState<string | null>(null);
 
     useEffect(() => {
         function getOperatingSystem() {
@@ -114,21 +115,31 @@ const Shortcut = () => {
         setOperatingSystem(getOperatingSystem());
     }, []);
 
-    return (
+    return operatingSystem ? (
         <div
             className={tcls(
                 'shortcut',
                 'hidden',
-                'md:inline',
+                'md:flex',
+                'gap-0.5',
+                '-mr-1',
                 'justify-end',
                 'text-xs',
                 'text-tint',
                 'contrast-more:text-tint-strong',
                 'whitespace-nowrap',
-                `[font-feature-settings:"calt",_"case"]`
+                `[font-feature-settings:"calt",_"case"]`,
+                'animate-fadeIn'
             )}
         >
-            {operatingSystem === 'mac' ? '⌘' : 'Ctrl +'} K
+            <kbd
+                className={`flex h-5 min-w-5 items-center justify-center rounded border border-tint-subtle theme-bold:border-header-link/5 bg-tint-base theme-bold:bg-header-background px-1 ${operatingSystem === 'mac' ? 'text-sm' : ''}`}
+            >
+                {operatingSystem === 'mac' ? '⌘' : 'Ctrl'}
+            </kbd>
+            <kbd className="flex size-5 items-center justify-center rounded border border-tint-subtle theme-bold:border-header-link/5 bg-tint-base theme-bold:bg-header-background">
+                K
+            </kbd>
         </div>
-    );
+    ) : null;
 };

packages/gitbook/src/components/Search/SearchModal.tsx

@@ -84,7 +84,7 @@ export function SearchModal(props: SearchModalProps) {
                             'bg-tint-12/4',
                             'dark:bg-tint-1/6',
                             'backdrop-blur-2xl',
-                            'z-30',
+                            'z-50',
                             'px-4',
                             'pt-4',
                             'md:pt-[min(8vh,6rem)]'