Version Packages (#3446)

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

.github/CODEOWNERS

@@ -0,0 +1,3 @@
+# Changes to the API data cache functions can invalidate all existing data cache
+# causing a massive amount of revalidation, impacting our API.
+packages/gitbook/src/lib/data/api.ts   @SamyPesse

.github/CONTRIBUTING.md

@@ -53,19 +53,42 @@ After forking this repository, you'll want to [create a branch](https://docs.git
 
 #### 3. Install dependencies and run the project locally
 
-GitBook uses [Bun](https://bun.sh/) to run the project. Make sure you're using the specified version of `node` before running any of the development commands to ensure a smooth development experience.
+##### Prerequisites:
+- Node.js (Version: >=20.6)
+  - Use `nvm` for easy Node management
+- [Bun](https://bun.sh/) (Version: >=1.2.15)
+  - We use a text-based lockfile which isn't supported below 1.2.15
 
-You can easily do this by running the command `nvm use`.
+##### Setup steps:
 
-To start your local version of GitBook, run the command `bun dev`.
+1. Ensure you are using the project's version of Node:
+```bash
+nvm use
+```
+
+2. Install dependencies using Bun:
+```bash
+bun install
+```
+
+3. Start the development server:
+```bash
+bun dev
+```
+
+Additional development commands:
+- `bun format`: Format the code using Biome
+- `bun typecheck`: Run TypeScript type checking
+- `bun unit`: Run unit tests
+- `bun e2e`: Run end-to-end tests
 
 #### 4. Preview your changes
 
-When running the development server, published GitBook sites can be rendered through your local version at `http://localhost:3000/`.
+When running the development server, published GitBook sites can be rendered through your local version at `http://localhost:3000/url`.
 
-For example, our published docs can be viewed using the local version by visiting `http://localhost:3000/docs.gitbook.com` after running the development server.
+For example, our published docs can be viewed using the local version by visiting `http://localhost:3000/url/gitbook.com/docs` after running the development server.
 
-You can visit any published GitBook site behind your development server. Please make sure your site is [published publicly](https://docs.gitbook.com/published-documentation/publish-your-content-as-a-docs-site) to ensure you can view the site correctly in your development version.
+You can visit any published GitBook site behind your development server. Please make sure your site is [published publicly](https://gitbook.com/docs/published-documentation/publish-your-content-as-a-docs-site) to ensure you can view the site correctly in your development version.
 
 ### Commit your update
 

.github/actions/gradual-deploy-cloudflare/action.yaml

@@ -0,0 +1,83 @@
+name: Gradual Deploy to Cloudflare
+description: Use gradual deployment to deploy to Cloudflare. This action will upload the middleware and server versions to Cloudflare and kept them bound together
+inputs:
+  apiToken:
+    description: 'Cloudflare API token'
+    required: true
+  accountId:
+    description: 'Cloudflare account ID'
+    required: true
+  environment:
+    description: 'Cloudflare environment to deploy to (staging, production, preview)'
+    required: true
+  middlewareVersionId:
+    description: 'Middleware version ID to deploy'
+    required: true
+  serverVersionId:
+    description: 'Server version ID to deploy'
+    required: true
+outputs:
+  deployment-url: 
+    description: "Deployment URL"
+    value: ${{ steps.deploy_middleware.outputs.deployment-url }}
+runs:
+  using: 'composite'
+  steps:
+      - id: wrangler_status
+        name: Check wrangler deployment status
+        uses: cloudflare/wrangler-action@v3.14.0
+        with:
+            apiToken: ${{ inputs.apiToken }}
+            accountId: ${{ inputs.accountId }}
+            workingDirectory: ./
+            wranglerVersion: '4.10.0'
+            environment: ${{ inputs.environment }}
+            command: deployments status --config ./packages/gitbook/openNext/customWorkers/defaultWrangler.jsonc
+
+      # This step is used to get the version ID that is currently deployed to Cloudflare.
+      - id: extract_current_version
+        name: Extract current version
+        shell: bash
+        run: |
+          version_id=$(echo "${{ steps.wrangler_status.outputs.command-output }}" | grep -A 3 "(100%)" | grep -oP '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}')
+          echo "version_id=$version_id" >> $GITHUB_OUTPUT
+
+      - id: deploy_server
+        name: Deploy server to Cloudflare at 0%
+        uses: cloudflare/wrangler-action@v3.14.0
+        with:
+            apiToken: ${{ inputs.apiToken }}
+            accountId: ${{ inputs.accountId }}
+            workingDirectory: ./
+            wranglerVersion: '4.10.0'
+            environment: ${{ inputs.environment }}
+            command: versions deploy ${{ steps.extract_current_version.outputs.version_id }}@100% ${{ inputs.serverVersionId }}@0% -y --config ./packages/gitbook/openNext/customWorkers/defaultWrangler.jsonc
+
+      # Since we use version overrides headers, we can directly deploy the middleware to 100%.
+      - id: deploy_middleware
+        name: Deploy middleware to Cloudflare at 100%
+        uses: cloudflare/wrangler-action@v3.14.0
+        with:
+            apiToken: ${{ inputs.apiToken }}
+            accountId: ${{ inputs.accountId }}
+            workingDirectory: ./
+            wranglerVersion: '4.10.0'
+            environment: ${{ inputs.environment }}
+            command: versions deploy ${{ inputs.middlewareVersionId }}@100% -y --config ./packages/gitbook/openNext/customWorkers/middlewareWrangler.jsonc
+
+      - name: Deploy server to Cloudflare at 100%
+        uses: cloudflare/wrangler-action@v3.14.0
+        with:
+            apiToken: ${{ inputs.apiToken }}
+            accountId: ${{ inputs.accountId }}
+            workingDirectory: ./
+            wranglerVersion: '4.10.0'
+            environment: ${{ inputs.environment }}
+            command: versions deploy ${{ inputs.serverVersionId }}@100% -y --config ./packages/gitbook/openNext/customWorkers/defaultWrangler.jsonc
+
+      - name: Outputs
+        shell: bash
+        env:
+          DEPLOYMENT_URL: ${{ steps.deploy_middleware.outputs.deployment-url }}
+        run: |
+            echo "URL: ${{ steps.deploy_middleware.outputs.deployment-url }}"

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

@@ -19,10 +19,16 @@ inputs:
   deploy:
     description: 'Deploy as main version for all traffic instead of uploading versions'
     required: true
+  commitTag:
+    description: 'Commit branch to associate with the deployment'
+    required: true
+  commitMessage:
+    description: 'Commit message to associate with the deployment'
+    required: true
 outputs:
     deployment-url: 
       description: "Deployment URL"
-      value: ${{ steps.deploy.outputs.deployment-url }}
+      value: ${{ steps.upload_middleware.outputs.deployment-url }}
 runs:
     using: 'composite'
     steps:
@@ -44,27 +50,89 @@ runs:
             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_IMAGE_RESIZE_MODE: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_MODE
             GITBOOK_ASSETS_PREFIX: ${{ inputs.opItem }}/GITBOOK_ASSETS_PREFIX
+            GITBOOK_FONTS_URL: ${{ inputs.opItem }}/GITBOOK_FONTS_URL
         - name: Build worker
-          run: bun run turbo build:v2:cloudflare
+          run: bun run turbo build:cloudflare
+          env:
+            GITBOOK_RUNTIME: cloudflare
           shell: bash
-        - id: deploy
+
-          name: Deploy to Cloudflare
+        - name: Upload the DO worker
           uses: cloudflare/wrangler-action@v3.14.0
           with:
               apiToken: ${{ inputs.apiToken }}
               accountId: ${{ inputs.accountId }}
               workingDirectory: ./
-              wranglerVersion: '3.112.0'
+              wranglerVersion: '4.10.0'
               environment: ${{ inputs.environment }}
-              command: ${{ fromJSON(inputs.deploy) == true && 'deploy' || 'versions upload' }} --config ./packages/gitbook-v2/wrangler.toml
+              command: deploy --config ./packages/gitbook/openNext/customWorkers/doWrangler.jsonc
+
+        - id: upload_server
+          name: Upload server to Cloudflare
+          uses: cloudflare/wrangler-action@v3.14.0
+          with:
+              apiToken: ${{ inputs.apiToken }}
+              accountId: ${{ inputs.accountId }}
+              workingDirectory: ./
+              wranglerVersion: '4.10.0'
+              environment: ${{ inputs.environment }}
+              command: ${{ format('versions upload --tag {0} --message "{1}"', inputs.commitTag, inputs.commitMessage) }} --config ./packages/gitbook/openNext/customWorkers/defaultWrangler.jsonc
+
+        - name: Extract server version worker ID
+          shell: bash
+          id: extract_server_version_id
+          run: |
+              version_id=$(echo '${{ steps.upload_server.outputs.command-output }}' | grep "Worker Version ID" | awk '{print $4}')
+              echo "version_id=$version_id" >> $GITHUB_OUTPUT
+
+        - name: Run updateWrangler scripts
+          shell: bash
+          run: |
+              bun run ./packages/gitbook/openNext/customWorkers/script/updateWrangler.ts ${{ steps.extract_server_version_id.outputs.version_id }}
+
+        - id: upload_middleware
+          name: Upload middleware to Cloudflare
+          uses: cloudflare/wrangler-action@v3.14.0
+          with:
+              apiToken: ${{ inputs.apiToken }}
+              accountId: ${{ inputs.accountId }}
+              workingDirectory: ./
+              wranglerVersion: '4.10.0'
+              environment: ${{ inputs.environment }}
+              command: ${{ format('versions upload --tag {0} --message "{1}"', inputs.commitTag, inputs.commitMessage) }} --config ./packages/gitbook/openNext/customWorkers/middlewareWrangler.jsonc
+        
+        - name: Extract middleware version worker ID
+          shell: bash
+          id: extract_middleware_version_id
+          run: |
+              version_id=$(echo '${{ steps.upload_middleware.outputs.command-output }}' | grep "Worker Version ID" | awk '{print $4}')
+              echo "version_id=$version_id" >> $GITHUB_OUTPUT
+
+        - name: Deploy server and middleware to Cloudflare
+          if: ${{ inputs.deploy == 'true' }}
+          uses: ./.github/actions/gradual-deploy-cloudflare
+          with:
+              apiToken: ${{ inputs.apiToken }}
+              accountId: ${{ inputs.accountId }}
+              opServiceAccount: ${{ inputs.opServiceAccount }}
+              opItem: ${{ inputs.opItem }}
+              environment: ${{ inputs.environment }}
+              serverVersionId: ${{ steps.extract_server_version_id.outputs.version_id }}
+              middlewareVersionId: ${{ steps.extract_middleware_version_id.outputs.version_id }}
+              deploy: ${{ inputs.deploy }}
+
+
         - name: Outputs
           shell: bash
           env:
-            DEPLOYMENT_URL: ${{ steps.deploy.outputs.deployment-url }}
+            DEPLOYMENT_URL: ${{ steps.upload_middleware.outputs.deployment-url }}
           run: |
-              echo "URL: ${{ steps.deploy.outputs.deployment-url }}"
+              echo "URL: ${{ steps.upload_middleware.outputs.deployment-url }}"
+              echo "Output server: ${{ steps.upload_server.outputs.command-output }}"

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

@@ -49,17 +49,21 @@ runs:
             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_IMAGE_RESIZE_MODE: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_MODE
             GITBOOK_ASSETS_PREFIX: ${{ inputs.opItem }}/GITBOOK_ASSETS_PREFIX
+            GITBOOK_FONTS_URL: ${{ inputs.opItem }}/GITBOOK_FONTS_URL
         - name: Build Project Artifacts
           run: bun run vercel build --target=${{ inputs.environment }} --token=${{ inputs.vercelToken }}
           shell: bash
           env:
             VERCEL_ORG_ID: ${{ inputs.vercelOrg }}
             VERCEL_PROJECT_ID: ${{ inputs.vercelProject }}
+            GITBOOK_RUNTIME: vercel
         - name: Deploy Project Artifacts to Vercel
           id: deploy
           shell: bash
@@ -73,3 +77,4 @@ runs:
           shell: bash
           run: |
               echo "URL: ${{ steps.deploy.outputs.deployment-url }}"
+

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

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

.github/workflows/deploy-preview.yaml

@@ -7,62 +7,6 @@ on:
 env:
     NPM_TOKEN_READONLY: ${{ secrets.NPM_TOKEN_READONLY }}
 jobs:
-    deploy-v1-cloudflare:
-        name: Deploy v1 to Cloudflare Pages
-        runs-on: ubuntu-latest
-        environment: 
-          name: ${{ github.ref == 'refs/heads/main' && '1c-production' || '1c-preview' }}
-          url: ${{ steps.deploy.outputs.deployment-url }}
-        permissions:
-            contents: read
-            deployments: write
-            issues: write
-            pull-requests: write
-            checks: write
-            statuses: write
-        outputs:
-            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
-            deployment-alias-url: ${{ steps.deploy.outputs.deployment-alias-url }}
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v4
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
-            - name: Install dependencies
-              run: bun install --frozen-lockfile
-              env:
-                  PUPPETEER_SKIP_DOWNLOAD: 1
-            - name: Sets env vars for production
-              if: github.ref == 'refs/heads/main'
-              run: |
-                echo "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
-              with:
-                  apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
-                  accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
-                  workingDirectory: ./
-                  wranglerVersion: '3.112.0'
-                  command: pages deploy ./packages/gitbook/.vercel/output/static --project-name=${{ vars.CLOUDFLARE_PROJECT_NAME }} --branch=${{ github.ref == 'refs/heads/main' && 'main' || format('pr{0}', github.event.pull_request.number) }}
-            - name: Outputs
-              run: |
-                  echo "URL: ${{ steps.deploy.outputs.deployment-url }}"
-                  echo "Alias URL: ${{ steps.deploy.outputs.deployment-alias-url }}"
     deploy-v2-vercel:
         name: Deploy v2 to Vercel (preview)
         runs-on: ubuntu-latest
@@ -91,7 +35,7 @@ jobs:
           name: 2c-preview
           url: ${{ steps.deploy.outputs.deployment-url }}
         outputs:
-            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
+            deployment-url: ${{ steps.deploy.outputs.deployment-url || steps.extract-worker-id.outputs.worker-url }}
         steps:
             - name: Checkout
               uses: actions/checkout@v4
@@ -105,15 +49,24 @@ jobs:
                   accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
                   opItem: op://gitbook-open/2c-preview
                   opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
+                  commitTag: ${{ github.ref == 'refs/heads/main' && 'main' || format('pr{0}', github.event.pull_request.number) }}
+                  commitMessage: ${{ github.sha }}
+            - name: Extract Worker ID
+              id: extract-worker-id
+              if: ${{ !steps.deploy.outputs.deployment-url }}
+              run: |
+                if [[ "${{ steps.deploy.outputs.command-output }}" =~ Worker\ Version\ ID:\ ([0-9a-f]{8})-([0-9a-f-]+) ]]; then
+                  WORKER_ID_FIRST_PART="${BASH_REMATCH[1]}"
+                  echo "worker-url=https://${WORKER_ID_FIRST_PART}-gitbook-open-v2-preview.gitbook.workers.dev/" >> $GITHUB_OUTPUT
+                fi
             - name: Outputs
               run: |
-                  echo "URL: ${{ steps.deploy.outputs.deployment-url }}"
+                  echo "URL: ${{ steps.deploy.outputs.deployment-url || steps.extract-worker-id.outputs.worker-url }}"
     comment-deployments:
         runs-on: ubuntu-latest
         name: Comment Deployments (preview)
         if: always() && !startsWith(github.ref, 'refs/heads/main')
         needs:
-            - deploy-v1-cloudflare
             - deploy-v2-vercel
             - deploy-v2-cloudflare
         steps:
@@ -133,15 +86,6 @@ jobs:
                   body: |
                       Summary of the deployments:
 
-                      ### Version 1 (production)
-
-                      | Version | URL | Status |
-                      | --- | --- | --- |
-                      | Latest commit | [${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}](${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}) | ${{ needs.deploy-v1-cloudflare.result == 'success' && '✅' || '❌' }} |
-                      | PR | [${{ needs.deploy-v1-cloudflare.outputs.deployment-alias-url }}](${{ needs.deploy-v1-cloudflare.outputs.deployment-alias-url }}) | ${{ needs.deploy-v1-cloudflare.result == 'success' && '✅' || '❌' }} |
-
-                      ### Version 2 (experimental)
-
                       | Version | URL | Status |
                       | --- | --- | --- |
                       | Vercel | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}](${{ needs.deploy-v2-vercel.outputs.deployment-url }}) | ${{ needs.deploy-v2-vercel.result == 'success' && '✅' || '❌' }} |
@@ -149,30 +93,11 @@ jobs:
 
                       ### Test content
 
-                      | Site | v1 | v2 |
+                      | Site | `2v` | `2c` |
                       | --- | --- | --- |
-                      | GitBook | [${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}/docs.gitbook.com](${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}/docs.gitbook.com) | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/docs.gitbook.com](${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/docs.gitbook.com) |
+                      | GitBook | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.com/docs](${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.com/docs) | [${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/gitbook.com/docs](${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/gitbook.com/docs) |
-                      | E2E | [${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}/gitbook.gitbook.io/test-gitbook-open) | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open) |
+                      | E2E | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open) | [${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open) |
                   edit-mode: replace
-    visual-testing-v1:
-        runs-on: ubuntu-latest
-        name: Visual Testing v1
-        needs: deploy-v1-cloudflare
-        timeout-minutes: 8
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v4
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
-            - name: Install dependencies
-              run: bun install --frozen-lockfile
-            - name: Setup Playwright
-              uses: ./.github/actions/setup-playwright
-            - name: Run Playwright tests
-              run: bun e2e
-              env:
-                  BASE_URL: ${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}
-                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
     visual-testing-v2-vercel:
         runs-on: ubuntu-latest
         name: Visual Testing v2
@@ -194,11 +119,11 @@ jobs:
                   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:
+    visual-testing-v2-cloudflare:
         runs-on: ubuntu-latest
-        name: Visual Testing Customers v1
+        name: Visual Testing v2 (Cloudflare)
-        needs: deploy-v1-cloudflare
+        needs: deploy-v2-cloudflare
-        timeout-minutes: 6
+        timeout-minutes: 10
         steps:
             - name: Checkout
               uses: actions/checkout@v4
@@ -209,16 +134,17 @@ jobs:
             - name: Setup Playwright
               uses: ./.github/actions/setup-playwright
             - name: Run Playwright tests
-              run: bun e2e-customers
+              run: bun e2e
               env:
-                  BASE_URL: ${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}
+                  BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}
+                  SITE_BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/
                   ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
-                  ARGOS_BUILD_NAME: 'customers-v1'
+                  ARGOS_BUILD_NAME: 'v2-cloudflare'
     visual-testing-customers-v2:
         runs-on: ubuntu-latest
         name: Visual Testing Customers v2
         needs: deploy-v2-vercel
-        timeout-minutes: 6
+        timeout-minutes: 10
         steps:
             - name: Checkout
               uses: actions/checkout@v4
@@ -235,10 +161,31 @@ jobs:
                   SITE_BASE_URL: ${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/
                   ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
                   ARGOS_BUILD_NAME: 'customers-v2'
-    pagespeed-testing-v1:
+    visual-testing-customers-v2-cloudflare:
+        runs-on: ubuntu-latest
+        name: Visual Testing Customers v2 (Cloudflare)
+        needs: deploy-v2-cloudflare
+        timeout-minutes: 10
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
+            - name: Install dependencies
+              run: bun install --frozen-lockfile
+            - name: Setup Playwright
+              uses: ./.github/actions/setup-playwright
+            - name: Run Playwright tests
+              run: bun e2e-customers
+              env:
+                  BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}
+                  SITE_BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/
+                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
+                  ARGOS_BUILD_NAME: 'customers-v2'
+    pagespeed-testing-v2:
         runs-on: ubuntu-latest
         name: PageSpeed Testing v1
-        needs: deploy-v1-cloudflare
+        needs: deploy-v2-vercel
         steps:
             - name: Checkout
               uses: actions/checkout@v4
@@ -251,5 +198,5 @@ jobs:
             - name: Run pagespeed tests
               run: bun ./packages/gitbook/tests/pagespeed-testing.ts
               env:
-                  BASE_URL: ${{needs.deploy-v1-cloudflare.outputs.deployment-url}}
+                  BASE_URL: ${{needs.deploy-v2-vercel.outputs.deployment-url}}
                   PAGESPEED_API_KEY: ${{ secrets.PAGESPEED_API_KEY }}

.github/workflows/deploy-production.yaml

@@ -17,7 +17,7 @@ jobs:
         steps:
             - name: Checkout
               uses: actions/checkout@v4
-            - name: Deploy staging
+            - name: Deploy
               id: deploy
               uses: ./.github/composite/deploy-vercel
               with:
@@ -48,6 +48,8 @@ jobs:
                   accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
                   opItem: op://gitbook-open/2c-production
                   opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
+                  commitTag: main
+                  commitMessage: ${{ github.sha }}
             - name: Outputs
               run: |
                   echo "URL: ${{ steps.deploy.outputs.deployment-url }}"

.github/workflows/deploy-staging.yaml

@@ -17,7 +17,7 @@ jobs:
         steps:
             - name: Checkout
               uses: actions/checkout@v4
-            - name: Deploy staging
+            - name: Deploy
               id: deploy
               uses: ./.github/composite/deploy-vercel
               with:
@@ -48,6 +48,8 @@ jobs:
                   accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
                   opItem: op://gitbook-open/2c-staging
                   opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
+                  commitTag: main
+                  commitMessage: ${{ github.sha }}
             - name: Outputs
               run: |
                   echo "URL: ${{ steps.deploy.outputs.deployment-url }}"

.github/workflows/publish.yaml

@@ -5,6 +5,9 @@ on:
         branches:
             - main
 
+env:
+    NPM_TOKEN_READONLY: ${{ secrets.NPM_TOKEN_READONLY }}
+    
 concurrency: ${{ github.workflow }}-${{ github.ref }}
 
 jobs:
@@ -36,22 +39,4 @@ jobs:
                   NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
                   CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
                   CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}
-    release-preview:
+
-        # For now it releases the cache-do to both preview and production
-        # Once we changed to deploy the app only on release, we should change `release:preview` in `cache-do`
-        name: Release Preview
-        runs-on: ubuntu-latest
-        steps:
-            - name: Checkout Repo
-              uses: actions/checkout@v3
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
-            - name: Install dependencies
-              run: bun install --frozen-lockfile
-              env:
-                  PUPPETEER_SKIP_DOWNLOAD: 1
-            - name: Release preview packages
-              run: bun run release:preview
-              env:
-                  CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
-                  CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}

.prettierignore

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

.prettierrc.json

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

.vscode/settings.json

@@ -9,9 +9,13 @@
     ],
     "tailwindCSS.classAttributes": ["class", "className", "style", ".*Style"],
     "prettier.enable": false,
+    "editor.formatOnSave": true,
     "editor.defaultFormatter": "biomejs.biome",
     "editor.codeActionsOnSave": {
         "source.organizeImports.biome": "explicit",
         "source.fixAll.biome": "explicit"
+    },
+    "[typescript]": {
+        "editor.defaultFormatter": "biomejs.biome"
     }
 }

README.md

@@ -1,7 +1,7 @@
 <h1 align="center">GitBook</h1>
 
 <p align="center">
-  <a href="https://docs.gitbook.com/">Docs</a> - <a href="https://github.com/GitbookIO/community">Community</a> - <a href="https://developer.gitbook.com/">Developer Docs</a> - <a href="https://changelog.gitbook.com/">Changelog</a> - <a href="https://github.com/GitbookIO/gitbook/issues/new?assignees=&labels=bug&template=bug_report.md">Bug reports</a> 
+  <a href="https://gitbook.com/docs/">Docs</a> - <a href="https://github.com/GitbookIO/community">Community</a> - <a href="https://developer.gitbook.com/">Developer Docs</a> - <a href="https://changelog.gitbook.com/">Changelog</a> - <a href="https://github.com/GitbookIO/gitbook/issues/new?assignees=&labels=bug&template=bug_report.md">Bug reports</a> - <a href="https://github.com/orgs/GitbookIO/discussions/categories/feature-requests">Feature requests</a> 
 </p>
 
 <p align="center">
@@ -37,8 +37,8 @@ To run a local version of this project, please follow these simple steps.
 
 - Node.js (Version: >=20.6)
     - Use nvm for easy Node management
--   Bun (Version: >=1.2.1)
+- [Bun](https://bun.sh/) (Version: >=1.2.15)
-  - We use a text-based lockfile which isn't supported below 1.2.1
+  - We use a text-based lockfile which isn't supported below 1.2.15
 
 ### Set up
 
@@ -62,20 +62,15 @@ bun install
 bun dev
 ```
 
-5. Open a published GitBook space in your web browser, prefixing it with `http://localhost:3000/`.
+6. Open a published GitBook space in your web browser, prefixing it with `http://localhost:3000/url`.
 
 examples:
 
--   http://localhost:3000/docs.gitbook.com
+-   http://localhost:3000/url/gitbook.com/docs
--   http://localhost:3000/open-source.gitbook.io/midjourney
+-   http://localhost:3000/url/open-source.gitbook.io/midjourney
 
 Any published GitBook site can be accessed through your local development instance, and any updates you make to the codebase will be reflected in your browser.
 
-### Other development commands
-
--   `bun format`: format the code
--   `bun lint`: lint the code
-
 ### CI and testing
 
 All pull-requests will be tested against both visual and performances testing to prevent regressions.
@@ -150,11 +145,11 @@ See `LICENSE` for more information.
 </p>
 
 ```md
-[![GitBook](https://img.shields.io/static/v1?message=Documented%20on%20GitBook&logo=gitbook&logoColor=ffffff&label=%20&labelColor=5c5c5c&color=3F89A1)](https://gitbook.com/)
+[![GitBook](https://img.shields.io/static/v1?message=Documented%20on%20GitBook&logo=gitbook&logoColor=ffffff&label=%20&labelColor=5c5c5c&color=3F89A1)](https://www.gitbook.com/preview?utm_source=gitbook_readme_badge&utm_medium=organic&utm_campaign=preview_documentation&utm_content=link)
 ```
 
 ```html
-<a href="https://gitbook.com">
+<a href="https://www.gitbook.com/preview?utm_source=gitbook_readme_badge&utm_medium=organic&utm_campaign=preview_documentation&utm_content=link">
     <img
         src="https://img.shields.io/static/v1?message=Documented%20on%20GitBook&logo=gitbook&logoColor=ffffff&label=%20&labelColor=5c5c5c&color=3F89A1"
     />

biome.json

@@ -18,7 +18,10 @@
             "**/.vercel/**/*",
             "**/.cache/**/*",
             "**/.wrangler/**/*",
-            "packages/openapi-parser/src/fixtures/**/*"
+            "packages/openapi-parser/src/fixtures/**/*",
+            "packages/emoji-codepoints/index.ts",
+            "packages/icons/src/data/*.json",
+            "packages/gitbook/worker-configuration.d.ts"
         ]
     },
     "formatter": {
@@ -124,7 +127,6 @@
         {
             "include": [
                 "packages/gitbook/**/*",
-                "packages/gitbook-v2/**/*",
                 "packages/react-openapi/**/*",
                 "packages/react-math/**/*",
                 "packages/react-contentkit/**/*",

package.json

@@ -4,21 +4,20 @@
     "devDependencies": {
         "@biomejs/biome": "^1.9.4",
         "@changesets/cli": "^2.27.12",
-        "turbo": "^2.4.4",
+        "turbo": "^2.5.0",
         "vercel": "^39.3.0"
     },
-    "packageManager": "bun@1.2.4",
+    "packageManager": "bun@1.2.15",
     "overrides": {
         "@codemirror/state": "6.4.1",
-        "react": "18.3.1",
+        "react": "^19.0.0",
-        "react-dom": "18.3.1"
+        "react-dom": "^19.0.0",
+        "esbuild": "0.24.2"
     },
     "private": true,
     "scripts": {
         "dev": "turbo run dev",
-        "dev:v2": "turbo run dev:v2",
         "build": "turbo run build",
-        "build:v2": "turbo run build:v2",
         "clean-deps": "rm -rf node_modules && rm -rf packages/*/node_modules",
         "typecheck": "turbo run typecheck",
         "format": "biome check --write ./",
@@ -29,11 +28,15 @@
         "changeset": "changeset",
         "changeset-version": "changeset version && bun run format",
         "release": "turbo run release && changeset publish",
-        "release:preview": "turbo run release:preview",
         "download:env": "op read op://gitbook-x-dev/gitbook-open/.env.local >> .env.local",
         "clean": "turbo run clean"
     },
-    "workspaces": ["packages/*"],
+    "workspaces": {
+        "packages": ["packages/*"],
+        "catalog": {
+            "@gitbook/api": "^0.128.0"
+        }
+    },
     "patchedDependencies": {
         "decode-named-character-reference@1.0.2": "patches/decode-named-character-reference@1.0.2.patch",
         "@vercel/next@4.4.2": "patches/@vercel%2Fnext@4.4.2.patch"

packages/cache-do/.gitignore

@@ -1,3 +0,0 @@
-.wrangler
-worker-configuration.d.ts
-dist/

packages/cache-do/CHANGELOG.md

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

packages/cache-do/README.md

@@ -1,22 +0,0 @@
-# `@gitbook/cache-do`
-
-Cache backend, powered by Cloudflare Durable Objects. The cache is optimized for GitBook use-cases.
-
-### Performances
-
-The cache backend is optimized for performances by being distributed and accessible close to the worker locations that are reading it.
-
-### Geo-distribution
-
-To achieve a good balance between **performances** and **consistency**, cache objects are distributed over 7 locations, representing continents.
-
-It makes it possible to purge all 7 locations in one go and achieve fast consistency.
-
-### Concepts
-
-**Cache tag**: unique tag in the cache environment. A cache tag groups multiple keys that should be purged together in one operation.
-Cache tags should not contain a large set of unique keys. Exceeding thousands could lead to performances or reliability issues.
-
-**Cache key**: unique key in the cache environment. Each key should be assigned to a `tag`.
-
-**Location**: cache is distributed over 7 unique locations, one for each continent.

packages/cache-do/package.json

@@ -1,35 +0,0 @@
-{
-    "name": "@gitbook/cache-do",
-    "type": "module",
-    "private": true,
-    "exports": {
-        ".": {
-            "types": "./dist/index.d.ts",
-            "development": "./src/index.ts",
-            "default": "./dist/index.js"
-        },
-        "./api": {
-            "types": "./dist/api.d.ts",
-            "development": "./src/api.ts",
-            "default": "./dist/api.js"
-        }
-    },
-    "version": "0.1.1",
-    "dependencies": {
-        "@msgpack/msgpack": "^3.0.0-beta2",
-        "lru_map": "^0.4.1"
-    },
-    "devDependencies": {
-        "typescript": "^5.5.3",
-        "wrangler": "^3.112.0"
-    },
-    "scripts": {
-        "generate": "wrangler types --experimental-include-runtime",
-        "build": "tsc",
-        "typecheck": "tsc --noEmit",
-        "dev": "tsc -w",
-        "release": "wrangler deploy",
-        "release:preview": "wrangler deploy && wrangler deploy --env preview"
-    },
-    "files": ["dist", "src", "bin", "data", "README.md", "CHANGELOG.md"]
-}

packages/cache-do/src/CacheObject.ts

@@ -1,292 +0,0 @@
-import { DurableObject } from 'cloudflare:workers';
-import { decode, encode } from '@msgpack/msgpack';
-import { LRUMap } from 'lru_map';
-
-export interface CacheObjectDescriptor {
-    get: <Value = unknown>(key: string) => Promise<Value | undefined>;
-    set: <Value = unknown>(key: string, value: Value, expiresAt: number) => Promise<void>;
-}
-
-/**
- * Value stored in a chunked binary msgpack format.
- * Stored under the key `prop.${key}.${index}`.
- */
-interface CacheObjectProp<Value = unknown> {
-    value: Value;
-    expiresAt: number;
-}
-
-/**
- * Expiration clock stored under the key `exp.${expiresAt}.${key}`.
- */
-interface CacheObjectExp {
-    /** Key of the property */
-    k: string;
-    /** Number of chunks */
-    c: number;
-}
-
-/**
- * Durable Object class being deployed as a distributed cache.
- */
-export class CacheObject extends DurableObject {
-    private lru = new LRUMap<string, { match: CacheObjectProp | undefined }>(500);
-
-    /**
-     * Open a descriptor to access the cache object.
-     * The goal is to minimize the amount of RPC sessions between the client and the cache object.
-     * One session is opened per request on the client side and used to perform multiple operations.
-     * https://developers.cloudflare.com/workers/runtime-apis/rpc/#return-functions-from-rpc-methods
-     */
-    public open(): CacheObjectDescriptor {
-        return {
-            get: async <Value = unknown>(key: string) => {
-                return this.get<Value>(key);
-            },
-            set: async <Value = unknown>(key: string, value: Value, expiresAt: number) => {
-                await this.set(key, value, expiresAt);
-            },
-        };
-    }
-
-    /**
-     * Get the value of a property.
-     */
-    public async get<Value = unknown>(key: string) {
-        return this.logOperation({ operation: 'get', key }, async (setLog) => {
-            // Try the memory state first.
-            const memoryEntry = this.lru.get(key);
-            if (memoryEntry) {
-                setLog({ memory: true });
-                setLog({ memoryMatch: !!memoryEntry.match });
-                if (!memoryEntry.match) {
-                    return;
-                }
-
-                const isExpired = memoryEntry.match.expiresAt < Date.now();
-                setLog({ memoryExpired: isExpired });
-
-                if (!isExpired) {
-                    return memoryEntry.match.value as Value;
-                }
-            }
-
-            return await this.getFromStorage<Value>(key);
-        });
-    }
-
-    /**
-     * Get the value of a property from the DO storage.
-     */
-    public async getFromStorage<Value = unknown>(key: string) {
-        return this.logOperation({ operation: 'getFromStorage', key }, async (setLog) => {
-            const entries = await this.ctx.storage.list<Uint8Array>({
-                prefix: getStoragePropKey(key),
-                noCache: true,
-            });
-            if (entries.size) {
-                const entry = decodeChunks<CacheObjectProp<Value>>(entries);
-                setLog({ chunks: entries.size, chunksSize: entry?.size ?? 0 });
-                if (entry && entry.value.expiresAt > Date.now()) {
-                    // Found
-                    this.lru.set(key, { match: entry.value });
-                    return entry.value.value;
-                }
-            }
-
-            // Not found
-            this.lru.set(key, { match: undefined });
-        });
-    }
-
-    /**
-     * Set a value in the cache object.
-     */
-    public async set<Value = unknown>(key: string, value: Value, expiresAt: number) {
-        return this.logOperation({ operation: 'set', key }, async (setLog) => {
-            const prop: CacheObjectProp<Value> = {
-                value,
-                expiresAt,
-            };
-
-            this.lru.set(key, { match: prop });
-            await this.ctx.storage.transaction(async (tx) => {
-                const entries = encodeChunks(key, prop);
-                const chunks = Object.keys(entries).length;
-                setLog({ chunks });
-
-                const clockValue: CacheObjectExp = {
-                    k: key,
-                    c: chunks,
-                };
-
-                await tx.put(getGCClockKey(key, expiresAt), clockValue);
-                await tx.put(entries);
-
-                const currentAlarm = await tx.getAlarm();
-                if (!currentAlarm) {
-                    // Set an alarm to garbage collect all entries that have expired in 12h.
-                    await tx.setAlarm(Date.now() + 12 * 60 * 60 * 1000);
-                }
-            });
-        });
-    }
-
-    /**
-     * Purge all keys in the cache object.
-     */
-    public async purge() {
-        return this.logOperation({ operation: 'purge' }, async (setLog) => {
-            const result = new Set<string>();
-
-            try {
-                // List all the keys in the cache object.
-                const entries = await this.ctx.storage.list<CacheObjectExp>({
-                    prefix: 'exp.',
-                    noCache: true,
-                });
-                setLog({ entries: entries.size });
-                entries.forEach((exp) => {
-                    result.add(exp.k);
-                });
-            } catch (_error) {}
-
-            await this.reset();
-            return Array.from(result);
-        });
-    }
-
-    /**
-     * Alarm to garbage collect all entries that have expired.
-     */
-    async alarm() {
-        return this.logOperation({ operation: 'alarm' }, async (setLog) => {
-            try {
-                const entries = await this.ctx.storage.list<CacheObjectExp>({
-                    prefix: 'exp.',
-                    noCache: true,
-                });
-                setLog({ entries: entries.size });
-                const toDeleteSet = new Set<string>();
-
-                for (const [key, exp] of entries) {
-                    const timestamp = Number.parseInt(key.split('.')[1]);
-                    if (timestamp < Date.now()) {
-                        toDeleteSet.add(key);
-                        for (let i = 0; i < exp.c; i++) {
-                            toDeleteSet.add(getStoragePropChunkKey(exp.k, i));
-                        }
-                    }
-                }
-
-                // Delete the keys by batch of 128.
-                const toDelete = Array.from(toDeleteSet);
-                setLog({ toDelete: toDelete.length });
-                for (let i = 0; i < toDelete.length; i += 128) {
-                    await this.ctx.storage.delete(toDelete.slice(i, i + 128));
-                }
-
-                // If there are still keys to delete, set an alarm to continue the deletion in 12h.
-                if (toDelete.length) {
-                    await this.ctx.storage.setAlarm(Date.now() + 12 * 60 * 60 * 1000);
-                }
-            } catch (_error) {
-                await this.reset();
-            }
-        });
-    }
-
-    /**
-     * Reset the cache object.
-     */
-    async reset() {
-        return this.logOperation({ operation: 'reset' }, async () => {
-            this.lru.clear();
-            await this.ctx.storage.deleteAll();
-        });
-    }
-
-    /**
-     * Time and log an operation.
-     */
-    async logOperation<T>(
-        log: Record<string, unknown>,
-        fn: (update: (log: Record<string, unknown>) => void) => Promise<T>
-    ): Promise<T> {
-        const objectId = this.ctx.id.name ?? this.ctx.id.toString();
-        const update: Record<string, unknown> = {};
-        const start = performance.now();
-        try {
-            return await fn((arg) => {
-                Object.assign(update, arg);
-            });
-        } finally {
-            const duration = performance.now() - start;
-            console.log({ ...log, ...update, objectId, duration });
-        }
-    }
-}
-
-function getStoragePropKey(key: string): string {
-    return `prop.${key}.`;
-}
-
-function getStoragePropChunkKey(key: string, index: number): string {
-    return `${getStoragePropKey(key)}${index}`;
-}
-
-function getGCClockRootKey(timestamp: number): string {
-    return `exp.${timestamp}.`;
-}
-
-function getGCClockKey(key: string, expiresAt: number): string {
-    return `${getGCClockRootKey(expiresAt)}${key}`;
-}
-
-function encodeChunks<T>(key: string, value: T): Record<string, Uint8Array> {
-    const buf = encode(value);
-    const entries: Record<string, Uint8Array> = {};
-    const chunks = chunkUint8Array(buf, 128 * 1024);
-
-    for (let index = 0; index < chunks.length; index++) {
-        entries[getStoragePropChunkKey(key, index)] = chunks[index];
-    }
-
-    return entries;
-}
-
-function decodeChunks<T>(entries: Map<string, Uint8Array>): { value: T; size: number } | undefined {
-    const chunks = Array.from(entries.entries())
-        .map(([key, value]) => {
-            const index = Number.parseInt(key.split('.').pop()!);
-            return [index, value] as const;
-        })
-        .sort(([a], [b]) => a - b)
-        .map(([, value]) => value);
-
-    if (chunks.length === 0) {
-        return;
-    }
-
-    const buf = mergeUint8Array(chunks);
-    return { value: decode(buf) as T, size: buf.length };
-}
-
-function chunkUint8Array(input: Uint8Array, chunkSize: number): Uint8Array[] {
-    const chunks: Uint8Array[] = [];
-    for (let i = 0; i < input.length; i += chunkSize) {
-        chunks.push(input.slice(i, i + chunkSize));
-    }
-    return chunks;
-}
-
-function mergeUint8Array(chunks: Uint8Array[]): Uint8Array {
-    const totalLength = chunks.reduce((sum, chunk) => sum + chunk.length, 0);
-    const result = new Uint8Array(totalLength);
-    let offset = 0;
-    for (const chunk of chunks) {
-        result.set(chunk, offset);
-        offset += chunk.length;
-    }
-    return result;
-}

packages/cache-do/src/CacheObjectStub.ts

@@ -1,97 +0,0 @@
-import type { CacheObject } from './CacheObject';
-
-export type CacheLocationId = ContinentCode;
-const allLocations: CacheLocationId[] = ['AF', 'AS', 'NA', 'SA', 'AN', 'EU', 'OC'];
-
-/**
- * Location hint for the CacheObject durable object.
- */
-const doLocationHints: {
-    [key in CacheLocationId]: DurableObjectLocationHint;
-} = {
-    AF: 'afr',
-    AS: 'apac',
-    NA: 'wnam',
-    SA: 'sam',
-    AN: 'oc',
-    EU: 'weur',
-    OC: 'oc',
-};
-
-/**
- * Client to access a cache tag.
- */
-export class CacheObjectStub {
-    private stub: DurableObjectStub<CacheObject>;
-
-    constructor(
-        /** Binding to the CacheObject durable object */
-        private doNamespace: DurableObjectNamespace<CacheObject>,
-        /** ID of the location to target */
-        private locationId: CacheLocationId,
-        /** Name of the tag */
-        private tag: string
-    ) {
-        const groupId = getCacheObjectIdName(this.locationId, this.tag);
-        this.stub = this.doNamespace.get(this.doNamespace.idFromName(groupId), {
-            // Initialize the object with a locaiton hint,
-            // as we might want to purge all locations before the object is created.
-            // https://developers.cloudflare.com/durable-objects/reference/data-location/
-            locationHint: doLocationHints[this.locationId],
-        });
-    }
-
-    /**
-     * Open a descriptor to the cache object.
-     * It can be used to perform multiple operations in a single RPC session.
-     * Ex:
-     * ```ts
-     * using desc = cache.open();
-     * await desc.set('key', 'value', Date.now() + 1000);
-     * await desc.get('key');
-     * ```
-     */
-    async open() {
-        return await this.stub.open();
-    }
-
-    /**
-     * Get a value from the cache.
-     */
-    async get<Value = unknown>(key: string) {
-        return (await this.stub.get(key)) as Value | undefined;
-    }
-
-    /**
-     * Set a value in the cache.
-     */
-    async set<Value = unknown>(key: string, value: Value, expiresAt: number) {
-        return await this.stub.set(key, value, expiresAt);
-    }
-
-    /**
-     * Purge all keys in the cache tag.
-     */
-    async purge() {
-        const keys = new Set<string>();
-        await Promise.all(
-            allLocations.map(async (locationId) => {
-                const groupId = getCacheObjectIdName(locationId, this.tag);
-                const cacheGroup = this.doNamespace.get(this.doNamespace.idFromName(groupId), {
-                    // Initialize the object with a locaiton hint,
-                    // as we might want to purge all locations before the object is created.
-                    // https://developers.cloudflare.com/durable-objects/reference/data-location/
-                    locationHint: doLocationHints[this.locationId],
-                });
-                const locationkeys = await cacheGroup.purge();
-                locationkeys.forEach((key) => keys.add(key));
-            })
-        );
-
-        return keys;
-    }
-}
-
-function getCacheObjectIdName(locationId: CacheLocationId, tag: string): string {
-    return `${locationId}:${tag}`;
-}

packages/cache-do/src/api.ts

@@ -1 +0,0 @@
-export * from './CacheObjectStub';

packages/cache-do/src/index.ts

@@ -1,9 +0,0 @@
-import { WorkerEntrypoint } from 'cloudflare:workers';
-
-export * from './CacheObject';
-
-export default class Worker extends WorkerEntrypoint {
-    fetch() {
-        return new Response('Hello, world!');
-    }
-}

packages/cache-do/tsconfig.json

@@ -1,21 +0,0 @@
-{
-    "compilerOptions": {
-        "target": "esnext",
-        "lib": ["dom", "dom.iterable", "esnext"],
-        "allowJs": true,
-        "skipLibCheck": true,
-        "strict": true,
-        "noEmit": false,
-        "declaration": true,
-        "outDir": "dist",
-        "esModuleInterop": true,
-        "module": "esnext",
-        "moduleResolution": "bundler",
-        "resolveJsonModule": true,
-        "isolatedModules": true,
-        "incremental": true,
-        "types": ["./.wrangler/types/runtime.d.ts"]
-    },
-    "include": ["src/**/*.ts"],
-    "exclude": ["node_modules"]
-}

packages/cache-do/wrangler.toml

@@ -1,27 +0,0 @@
-main = "./src/index.ts"
-name = "gitbook-open-cache"
-compatibility_date = "2024-09-02"
-
-durable_objects.bindings = [
-  {name = "CACHE", class_name = "CacheObject"}
-]
-
-migrations = [
-  {tag = "v1", new_classes = ["CacheObject"]}
-]
-
-[observability]
-enabled = false
-
-[env.preview]
-name = "gitbook-open-cache-preview"
-durable_objects.bindings = [
-  {name = "CACHE", class_name = "CacheObject"}
-]
-migrations = [
-  {tag = "v1", new_classes = ["CacheObject"]}
-]
-
-[env.preview.observability]
-enabled = true
-head_sampling_rate = 0.1

packages/cache-tags/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @gitbook/cache-tags
 
+## 0.3.1
+
+### Patch Changes
+
+- 77397ca: Fix version of @gitbook/api referenced in package.json
+
+## 0.3.0
+
+### Minor Changes
+
+- 116575c: Improve typing of getComputedContentSourceCacheTags to match latest API specification
+
+## 0.2.0
+
+### Minor Changes
+
+- f32bf1f: Export function `getCacheTagForURL` to easily get the cache tag for a URL.
+
 ## 0.1.0
 
 ### Minor Changes

packages/cache-tags/package.json

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

packages/cache-tags/src/index.ts

@@ -60,7 +60,7 @@ export function getCacheTag(
         | {
               tag: 'computed-document';
               space: string;
-              integration: string;
+              sourceType: string;
           }
         /**
          * All data related to the URL of a content
@@ -84,6 +84,14 @@ export function getCacheTag(
               organization: string;
               openAPISpec: string;
           }
+        /**
+         * All data related to a translation
+         */
+        | {
+              tag: 'translation';
+              organization: string;
+              translationSettings: string;
+          }
 ): string {
     switch (spec.tag) {
         case 'user':
@@ -99,18 +107,31 @@ export function getCacheTag(
         case 'document':
             return `space:${spec.space}:document:${spec.document}`;
         case 'computed-document':
-            return `space:${spec.space}:computed-document:${spec.integration}`;
+            return `space:${spec.space}:computed-document:${spec.sourceType}`;
         case 'site':
             return `site:${spec.site}`;
         case 'integration':
             return `integration:${spec.integration}`;
         case 'openapi':
             return `organization:${spec.organization}:openapi:${spec.openAPISpec}`;
+        case 'translation':
+            return `organization:${spec.organization}:translation:${spec.translationSettings}`;
         default:
             assertNever(spec);
     }
 }
 
+/**
+ * Get the cache tag for a given URL.
+ */
+export function getCacheTagForURL(url: string | URL) {
+    const parsedURL = url instanceof URL ? url : new URL(url);
+    return getCacheTag({
+        tag: 'url',
+        hostname: parsedURL.hostname,
+    });
+}
+
 /**
  * Get the tags for a computed content source.
  */
@@ -146,6 +167,15 @@ export function getComputedContentSourceCacheTags(
                         })
                     );
                     break;
+                case 'translation-language':
+                    tags.push(
+                        getCacheTag({
+                            tag: 'translation',
+                            organization: inContext.organizationId,
+                            translationSettings: dependency.ref.translationSettings,
+                        })
+                    );
+                    break;
                 default:
                     // Do not throw for unknown dependency types
                     // as it might mean we are lacking behind the API version
@@ -158,18 +188,22 @@ export function getComputedContentSourceCacheTags(
             getCacheTag({
                 tag: 'computed-document',
                 space: inContext.spaceId,
-                integration: source.integration,
+                sourceType: source.type,
             })
         );
     }
 
     // We invalidate the computed content when a new version of the integration is deployed.
+
+    if (source.type.startsWith('integration:')) {
+        const integration = source.type.split(':')[1];
         tags.push(
             getCacheTag({
                 tag: 'integration',
-            integration: source.integration,
+                integration,
             })
         );
+    }
 
     return tags;
 }

packages/colors/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @gitbook/colors
 
+## 0.3.3
+
+### Patch Changes
+
+- c3f6b8c: Update chroma ratio per step
+- 5e975ab: Fix code highlighting for HTTP
+- f7a3470: Change lightness check for color step 9 to allow input colors with a higher-than-needed contrast
+
+## 0.3.2
+
+### Patch Changes
+
+- cdffd7c: Desaturate text colors by decreasing chroma for the last steps of the color scale
+
+## 0.3.1
+
+### Patch Changes
+
+- fb90eb0: Reduce chroma of first color scale step
+
+## 0.3.0
+
+### Minor Changes
+
+- 4f0a772: Override tint lightness if supplied color is out of bounds
+
 ## 0.2.0
 
 ### Minor Changes

packages/colors/package.json

@@ -8,7 +8,7 @@
             "default": "./dist/index.js"
         }
     },
-    "version": "0.2.0",
+    "version": "0.3.3",
     "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 = [];
 
@@ -200,13 +214,31 @@ export function colorScale(
         const targetL =
             foregroundColor.L * mapping[index] + backgroundColor.L * (1 - mapping[index]);
 
-        if (index === 8 && !mix && Math.abs(baseColor.L - targetL) < 0.2) {
+        if (
+            index === 8 &&
+            !mix &&
+            (darkMode ? targetL - baseColor.L < 0.2 : baseColor.L - targetL < 0.2)
+        ) {
             // Original colour is close enough to target, so let's use the original colour as step 9.
             result.push(hex);
             continue;
         }
 
-        const chromaRatio = index < 8 ? (index + 1) * 0.05 : 1;
+        const chromaRatio = (() => {
+            switch (index) {
+                // Step 9 and 10 have max chroma, meaning they are fully saturated.
+                case 8:
+                case 9:
+                    return 1;
+                // Step 11 and 12 have a reduced chroma
+                case 10:
+                    return 0.4;
+                case 11:
+                    return 0.1;
+                default:
+                    return index * 0.05;
+            }
+        })();
 
         const shade = {
             L: targetL, // Blend lightness

packages/fonts/.gitignore

@@ -0,0 +1,2 @@
+dist/
+src/data/*.json

packages/fonts/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @gitbook/fonts
+
+## 0.1.0
+
+### Minor Changes
+
+- fbfcca5: Initial version of the package

packages/fonts/README.md

@@ -0,0 +1,3 @@
+# `@gitbook/fonts`
+
+Utilities to lookup default fonts supported by GitBook.

packages/fonts/bin/generate.ts

@@ -0,0 +1,91 @@
+import fs from 'node:fs/promises';
+import path from 'node:path';
+
+import { APIv2 } from 'google-font-metadata';
+
+import { CustomizationDefaultFont } from '@gitbook/api';
+
+import type { FontDefinitions } from '../src/types';
+
+const googleFontsMap: { [fontName in CustomizationDefaultFont]: string } = {
+    [CustomizationDefaultFont.Inter]: 'inter',
+    [CustomizationDefaultFont.FiraSans]: 'fira-sans-extra-condensed',
+    [CustomizationDefaultFont.IBMPlexSerif]: 'ibm-plex-serif',
+    [CustomizationDefaultFont.Lato]: 'lato',
+    [CustomizationDefaultFont.Merriweather]: 'merriweather',
+    [CustomizationDefaultFont.NotoSans]: 'noto-sans',
+    [CustomizationDefaultFont.OpenSans]: 'open-sans',
+    [CustomizationDefaultFont.Overpass]: 'overpass',
+    [CustomizationDefaultFont.Poppins]: 'poppins',
+    [CustomizationDefaultFont.Raleway]: 'raleway',
+    [CustomizationDefaultFont.Roboto]: 'roboto',
+    [CustomizationDefaultFont.RobotoSlab]: 'roboto-slab',
+    [CustomizationDefaultFont.SourceSansPro]: 'source-sans-3',
+    [CustomizationDefaultFont.Ubuntu]: 'ubuntu',
+    [CustomizationDefaultFont.ABCFavorit]: 'inter',
+};
+
+/**
+ * Scripts to generate the list of all icons.
+ */
+async function main() {
+    // @ts-expect-error - we build the object
+    const output: FontDefinitions = {};
+
+    for (const font of Object.values(CustomizationDefaultFont)) {
+        const googleFontName = googleFontsMap[font];
+        const fontMetadata = APIv2[googleFontName.toLowerCase()];
+        if (!fontMetadata) {
+            throw new Error(`Font ${googleFontName} not found`);
+        }
+
+        output[font] = {
+            font: googleFontName,
+            unicodeRange: fontMetadata.unicodeRange,
+            variants: {
+                '400': {},
+                '700': {},
+            },
+        };
+
+        Object.keys(output[font].variants).forEach((weight) => {
+            const variants = fontMetadata.variants[weight];
+            const normalVariant = variants.normal;
+            if (!normalVariant) {
+                throw new Error(`Font ${googleFontName} has no normal variant`);
+            }
+
+            output[font].variants[weight] = {};
+            Object.entries(normalVariant).forEach(([script, url]) => {
+                output[font].variants[weight][script] = url.url.woff;
+            });
+        });
+    }
+
+    await writeDataFile('fonts', JSON.stringify(output, null, 2));
+}
+
+/**
+ * We write both in dist and src as the build process might have happen already
+ * and tsc doesn't copy the files.
+ */
+async function writeDataFile(name, content) {
+    const srcData = path.resolve(__dirname, '../src/data');
+    const distData = path.resolve(__dirname, '../dist/data');
+
+    // Ensure the directories exists
+    await Promise.all([
+        fs.mkdir(srcData, { recursive: true }),
+        fs.mkdir(distData, { recursive: true }),
+    ]);
+
+    await Promise.all([
+        fs.writeFile(path.resolve(srcData, `${name}.json`), content),
+        fs.writeFile(path.resolve(distData, `${name}.json`), content),
+    ]);
+}
+
+main().catch((error) => {
+    console.error(`Error generating icons list: ${error}`);
+    process.exit(1);
+});

packages/fonts/package.json

@@ -0,0 +1,31 @@
+{
+    "name": "@gitbook/fonts",
+    "type": "module",
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "development": "./src/index.ts",
+            "default": "./dist/index.js"
+        }
+    },
+    "version": "0.1.0",
+    "dependencies": {
+        "@gitbook/api": "catalog:"
+    },
+    "devDependencies": {
+        "google-font-metadata": "^6.0.3",
+        "typescript": "^5.5.3"
+    },
+    "scripts": {
+        "generate": "bun ./bin/generate.js",
+        "build": "tsc --project tsconfig.build.json",
+        "typecheck": "tsc --noEmit",
+        "dev": "tsc -w",
+        "clean": "rm -rf ./dist && rm -rf ./src/data",
+        "unit": "bun test"
+    },
+    "files": ["dist", "src", "bin", "README.md", "CHANGELOG.md"],
+    "engines": {
+        "node": ">=20.0.0"
+    }
+}

packages/fonts/src/__snapshots__/getDefaultFont.test.ts.snap

@@ -0,0 +1,57 @@
+// Bun Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`getDefaultFont should return correct object for Latin text 1`] = `
+{
+  "font": "Inter",
+  "url": "https://fonts.gstatic.com/s/inter/v18/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZ9hjp-Ek-_0ew.woff",
+}
+`;
+
+exports[`getDefaultFont should return correct object for Cyrillic text 1`] = `
+{
+  "font": "Inter",
+  "url": "https://fonts.gstatic.com/s/inter/v18/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZthjp-Ek-_0ewmM.woff",
+}
+`;
+
+exports[`getDefaultFont should return correct object for Greek text 1`] = `
+{
+  "font": "Inter",
+  "url": "https://fonts.gstatic.com/s/inter/v18/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZxhjp-Ek-_0ewmM.woff",
+}
+`;
+
+exports[`getDefaultFont should handle mixed script text 1`] = `
+{
+  "font": "Inter",
+  "url": "https://fonts.gstatic.com/s/inter/v18/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZthjp-Ek-_0ewmM.woff",
+}
+`;
+
+exports[`getDefaultFont should handle different font weights: regular 1`] = `
+{
+  "font": "Inter",
+  "url": "https://fonts.gstatic.com/s/inter/v18/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZ9hjp-Ek-_0ew.woff",
+}
+`;
+
+exports[`getDefaultFont should handle different font weights: bold 1`] = `
+{
+  "font": "Inter",
+  "url": "https://fonts.gstatic.com/s/inter/v18/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuFuYAZ9hjp-Ek-_0ew.woff",
+}
+`;
+
+exports[`getDefaultFont should handle different fonts: inter 1`] = `
+{
+  "font": "Inter",
+  "url": "https://fonts.gstatic.com/s/inter/v18/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZ9hjp-Ek-_0ew.woff",
+}
+`;
+
+exports[`getDefaultFont should handle different fonts: roboto 1`] = `
+{
+  "font": "Roboto",
+  "url": "https://fonts.gstatic.com/s/roboto/v32/KFOmCnqEu92Fr1Mu4mxMKTU1Kg.woff",
+}
+`;

packages/fonts/src/fonts.ts

@@ -0,0 +1,5 @@
+import type { FontDefinitions } from './types';
+
+import rawFonts from './data/fonts.json' with { type: 'json' };
+
+export const fonts: FontDefinitions = rawFonts;

packages/fonts/src/getDefaultFont.test.ts

@@ -0,0 +1,119 @@
+import { describe, expect, it } from 'bun:test';
+import { CustomizationDefaultFont } from '@gitbook/api';
+import { getDefaultFont } from './getDefaultFont';
+
+describe('getDefaultFont', () => {
+    it('should return null for invalid font', () => {
+        const result = getDefaultFont({
+            font: 'invalid-font' as CustomizationDefaultFont,
+            text: 'Hello',
+            weight: 400,
+        });
+        expect(result).toBeNull();
+    });
+
+    it('should return null for invalid weight', () => {
+        const result = getDefaultFont({
+            font: CustomizationDefaultFont.Inter,
+            text: 'Hello',
+            weight: 999 as any,
+        });
+        expect(result).toBeNull();
+    });
+
+    it('should return null for text not supported by any script', () => {
+        const result = getDefaultFont({
+            font: CustomizationDefaultFont.Inter,
+            text: '😀', // Emoji not supported by Inter
+            weight: 400,
+        });
+        expect(result).toBeNull();
+    });
+
+    it('should return correct object for Latin text', () => {
+        const result = getDefaultFont({
+            font: CustomizationDefaultFont.Inter,
+            text: 'Hello World',
+            weight: 400,
+        });
+        expect(result).not.toBeNull();
+        expect(result?.font).toBe(CustomizationDefaultFont.Inter);
+        expect(result).toMatchSnapshot();
+    });
+
+    it('should return correct object for Cyrillic text', () => {
+        const result = getDefaultFont({
+            font: CustomizationDefaultFont.Inter,
+            text: 'Привет мир',
+            weight: 400,
+        });
+        expect(result).not.toBeNull();
+        expect(result?.font).toBe(CustomizationDefaultFont.Inter);
+        expect(result).toMatchSnapshot();
+    });
+
+    it('should return correct object for Greek text', () => {
+        const result = getDefaultFont({
+            font: CustomizationDefaultFont.Inter,
+            text: 'Γεια σας',
+            weight: 400,
+        });
+        expect(result).not.toBeNull();
+        expect(result?.font).toBe(CustomizationDefaultFont.Inter);
+        expect(result).toMatchSnapshot();
+    });
+
+    it('should handle mixed script text', () => {
+        const result = getDefaultFont({
+            font: CustomizationDefaultFont.Inter,
+            text: 'Hello Привет',
+            weight: 400,
+        });
+        expect(result).not.toBeNull();
+        expect(result?.font).toBe(CustomizationDefaultFont.Inter);
+        expect(result).toMatchSnapshot();
+    });
+
+    it('should handle different font weights', () => {
+        const regular = getDefaultFont({
+            font: CustomizationDefaultFont.Inter,
+            text: 'Hello',
+            weight: 400,
+        });
+        const bold = getDefaultFont({
+            font: CustomizationDefaultFont.Inter,
+            text: 'Hello',
+            weight: 700,
+        });
+        expect(regular).not.toBeNull();
+        expect(bold).not.toBeNull();
+        expect(regular).toMatchSnapshot('regular');
+        expect(bold).toMatchSnapshot('bold');
+    });
+
+    it('should handle empty string', () => {
+        const result = getDefaultFont({
+            font: CustomizationDefaultFont.Inter,
+            text: '',
+            weight: 400,
+        });
+        expect(result).toBeNull();
+    });
+
+    it('should handle different fonts', () => {
+        const inter = getDefaultFont({
+            font: CustomizationDefaultFont.Inter,
+            text: 'Hello',
+            weight: 400,
+        });
+        const roboto = getDefaultFont({
+            font: CustomizationDefaultFont.Roboto,
+            text: 'Hello',
+            weight: 400,
+        });
+        expect(inter).not.toBeNull();
+        expect(roboto).not.toBeNull();
+        expect(inter).toMatchSnapshot('inter');
+        expect(roboto).toMatchSnapshot('roboto');
+    });
+});

packages/fonts/src/getDefaultFont.ts

@@ -0,0 +1,112 @@
+import type { CustomizationDefaultFont } from '@gitbook/api';
+import { fonts } from './fonts';
+import type { FontWeight } from './types';
+
+/**
+ * Get the URL to load a font for a text.
+ */
+export function getDefaultFont(input: {
+    /**
+     * GitBook font to use.
+     */
+    font: CustomizationDefaultFont;
+
+    /**
+     * Text to display with the font.
+     */
+    text: string;
+
+    /**
+     * Font weight to use.
+     */
+    weight: FontWeight;
+}): { font: string; url: string } | null {
+    if (!input.text.trim()) {
+        return null;
+    }
+
+    const fontDefinition = fonts[input.font];
+    if (!fontDefinition) {
+        return null;
+    }
+
+    const variant = fontDefinition.variants[`${input.weight}`];
+    if (!variant) {
+        return null;
+    }
+
+    const script = getBestUnicodeRange(input.text, fontDefinition.unicodeRange);
+    if (!script) {
+        return null;
+    }
+
+    return variant[script]
+        ? {
+              font: input.font,
+              url: variant[script],
+          }
+        : null;
+}
+
+/**
+ * Determine which named @font-face unicode-range covers
+ * the greatest share of the characters in `text`.
+ *
+ * @param text   The text you want to inspect.
+ * @param ranges An object whose keys are range names and whose
+ *               values are CSS-style comma-separated unicode-range
+ *               declarations (e.g. "U+0370-03FF,U+1F00-1FFF").
+ * @returns      The key of the best-matching range, or `null`
+ *               when nothing matches at all.
+ */
+function getBestUnicodeRange(text: string, ranges: Record<string, string>): string | null {
+    // ---------- helper: parse "U+XXXX" or "U+XXXX-YYYY" ----------
+    const parseOne = (token: string): [number, number] | null => {
+        token = token.trim().toUpperCase();
+        if (!token.startsWith('U+')) return null;
+
+        const body = token.slice(2); // drop "U+"
+        const [startHex, endHex] = body.split('-');
+        const start = Number.parseInt(startHex, 16);
+        const end = endHex ? Number.parseInt(endHex, 16) : start;
+
+        if (Number.isNaN(start) || Number.isNaN(end) || end < start) return null;
+        return [start, end];
+    };
+
+    // ---------- helper: build lookup table ----------
+    const parsed: Record<string, [number, number][]> = {};
+    for (const [label, list] of Object.entries(ranges)) {
+        parsed[label] = list
+            .split(',')
+            .map(parseOne)
+            .filter((x): x is [number, number] => x !== null);
+    }
+
+    // ---------- tally code-point hits ----------
+    const hits: Record<string, number> = Object.fromEntries(Object.keys(parsed).map((k) => [k, 0]));
+
+    for (let i = 0; i < text.length; ) {
+        const cp = text.codePointAt(i)!;
+        i += cp > 0xffff ? 2 : 1; // advance by 1 UTF-16 code-unit (or 2 for surrogates)
+
+        for (const [label, rangesArr] of Object.entries(parsed)) {
+            if (rangesArr.some(([lo, hi]) => cp >= lo && cp <= hi)) {
+                hits[label]++;
+            }
+        }
+    }
+
+    // ---------- choose the "best" ----------
+    let winner: string | null = null;
+    let maxCount = 0;
+
+    for (const [label, count] of Object.entries(hits)) {
+        if (count > maxCount) {
+            maxCount = count;
+            winner = label;
+        }
+    }
+
+    return maxCount > 0 ? winner : null;
+}

packages/fonts/src/index.ts

@@ -0,0 +1,2 @@
+export * from './getDefaultFont';
+export * from './types';

packages/fonts/src/types.ts

@@ -0,0 +1,17 @@
+import type { CustomizationDefaultFont } from '@gitbook/api';
+
+export type FontWeight = 400 | 700;
+
+export type FontDefinition = {
+    font: string;
+    unicodeRange: {
+        [script: string]: string;
+    };
+    variants: {
+        [weight in string]: {
+            [script: string]: string;
+        };
+    };
+};
+
+export type FontDefinitions = { [fontName in CustomizationDefaultFont]: FontDefinition };

packages/fonts/tsconfig.build.json

@@ -0,0 +1,4 @@
+{
+    "extends": "./tsconfig.json",
+    "exclude": ["node_modules", "src/**/*.test.ts"]
+}

packages/fonts/tsconfig.json

@@ -1,18 +1,19 @@
 {
     "compilerOptions": {
-        "target": "esnext",
+        "lib": ["es2023"],
-        "lib": ["dom", "dom.iterable", "esnext"],
+        "module": "ESNext",
-        "allowJs": true,
+        "target": "es2022",
-        "skipLibCheck": true,
         "strict": true,
+        "esModuleInterop": true,
+        "skipLibCheck": true,
+        "moduleResolution": "bundler",
+        "allowJs": true,
         "noEmit": false,
         "declaration": true,
         "outDir": "dist",
-        "esModuleInterop": true,
-        "module": "esnext",
-        "moduleResolution": "bundler",
         "resolveJsonModule": true,
         "isolatedModules": true,
+        "jsx": "react-jsx",
         "incremental": true,
         "types": [
             "bun-types" // add Bun global

packages/fonts/turbo.json

@@ -0,0 +1,9 @@
+{
+    "extends": ["//"],
+    "tasks": {
+        "generate": {
+            "inputs": ["bin/**/*", "package.json"],
+            "outputs": ["src/data/*.json", "dist/data/*.json"]
+        }
+    }
+}

packages/gitbook-v2/.gitignore

@@ -1,11 +0,0 @@
-# next.js
-/.next/
-
-# vercel
-.vercel
-
-# cloudflare
-.open-next
-
-# Symbolic links
-public

packages/gitbook-v2/CHANGELOG.md

@@ -1,27 +0,0 @@
-# gitbook-v2
-
-## 0.2.0
-
-### Minor Changes
-
--   76c7974: Add route to revalidate cached data
-
-## 0.1.2
-
-### Patch Changes
-
--   05ffd0e: Improving data cache management for computed content
--   Updated dependencies [05ffd0e]
-    -   @gitbook/cache-tags@0.1.0
-
-## 0.1.1
-
-### Patch Changes
-
--   3e11678: fix: lost section groups
-
-## 0.1.0
-
-### Minor Changes
-
--   cfccc44: Setup structure and deployment for new version

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

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

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

@@ -1,10 +0,0 @@
-import { defineCloudflareConfig } from '@opennextjs/cloudflare';
-import d1TagCache from '@opennextjs/cloudflare/d1-tag-cache';
-import kvIncrementalCache from '@opennextjs/cloudflare/kv-cache';
-import memoryQueue from '@opennextjs/cloudflare/memory-queue';
-
-export default defineCloudflareConfig({
-    incrementalCache: kvIncrementalCache,
-    queue: memoryQueue,
-    tagCache: d1TagCache,
-});

packages/gitbook-v2/package.json

@@ -1,31 +0,0 @@
-{
-    "name": "gitbook-v2",
-    "version": "0.2.0",
-    "private": true,
-    "dependencies": {
-        "next": "^15.2.1",
-        "react": "^19.0.0",
-        "react-dom": "^19.0.0",
-        "@gitbook/api": "0.96.1",
-        "@gitbook/cache-tags": "workspace:*",
-        "@sindresorhus/fnv1a": "^3.1.0",
-        "server-only": "^0.0.1",
-        "warn-once": "^0.1.1"
-    },
-    "devDependencies": {
-        "gitbook": "*",
-        "@opennextjs/cloudflare": "https://pkg.pr.new/opennextjs/opennextjs-cloudflare/@opennextjs/cloudflare@236c84d",
-        "tailwindcss": "^3.4.0",
-        "postcss": "^8"
-    },
-    "scripts": {
-        "generate": "rm -rf ./public && cp -r ../gitbook/public ./public",
-        "dev:v2": "env-cmd --silent -f ../../.env.local next --turbopack",
-        "build": "next build",
-        "build:v2": "next build",
-        "start": "next start",
-        "build:v2:cloudflare": "opennextjs-cloudflare",
-        "dev:v2:cloudflare": "wrangler dev --port 8771",
-        "unit": "bun test"
-    }
-}

packages/gitbook-v2/postcss.config.js

@@ -1,6 +0,0 @@
-module.exports = {
-    plugins: {
-        tailwindcss: {},
-        autoprefixer: {},
-    },
-};

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

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

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

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

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

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

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

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

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

@@ -1,76 +0,0 @@
-import {
-    fetchSiteContextByURL,
-    fetchSiteContextByURLLookup,
-    getBaseContext,
-} from '@v2/lib/context';
-import { getSiteURLDataFromMiddleware } from '@v2/lib/middleware';
-
-export type RouteParamMode = 'url-host' | 'url';
-
-export type RouteLayoutParams = {
-    mode: string;
-
-    /** URL encoded site URL */
-    siteURL: string;
-};
-
-export type RouteParams = RouteLayoutParams & {
-    pagePath: string;
-};
-
-/**
- * Get the static context when rendering statically a site.
- */
-export function getStaticSiteContext(params: RouteLayoutParams) {
-    const siteURL = getSiteURLFromParams(params);
-    return fetchSiteContextByURL(
-        getBaseContext({
-            siteURL,
-            urlMode: getModeFromParams(params.mode),
-        }),
-        {
-            url: siteURL.toString(),
-            visitorAuthToken: null,
-            redirectOnError: false,
-        }
-    );
-}
-
-/**
- * Get the site context when rendering dynamically.
- * The context will depend on the request.
- */
-export async function getDynamicSiteContext(params: RouteLayoutParams) {
-    const siteURL = getSiteURLFromParams(params);
-    const siteURLData = await getSiteURLDataFromMiddleware();
-
-    return fetchSiteContextByURLLookup(
-        getBaseContext({
-            siteURL,
-            urlMode: getModeFromParams(params.mode),
-        }),
-        siteURLData
-    );
-}
-
-/**
- * Get the decoded page path from the params.
- */
-export function getPagePathFromParams(params: RouteParams) {
-    const decoded = decodeURIComponent(params.pagePath);
-    return decoded;
-}
-
-function getSiteURLFromParams(params: RouteLayoutParams) {
-    const decoded = decodeURIComponent(params.siteURL);
-    const url = new URL(`https://${decoded}`);
-    return url;
-}
-
-function getModeFromParams(mode: string): RouteParamMode {
-    if (mode === 'url-host') {
-        return 'url-host';
-    }
-
-    return 'url';
-}

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

@@ -1,2 +0,0 @@
-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

@@ -1,4 +0,0 @@
-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

@@ -1,2 +0,0 @@
-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

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

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

@@ -1,554 +0,0 @@
-import { type ComputedContentSource, GitBookAPI } from '@gitbook/api';
-import { getCacheTag, getComputedContentSourceCacheTags } from '@gitbook/cache-tags';
-import { GITBOOK_API_TOKEN, GITBOOK_API_URL, GITBOOK_USER_AGENT } from '@v2/lib/env';
-import { unstable_cacheLife as cacheLife, unstable_cacheTag as cacheTag } from 'next/cache';
-import { wrapDataFetcherError } from './errors';
-import type { GitBookDataFetcher } from './types';
-
-interface DataFetcherInput {
-    /**
-     * API host to use.
-     */
-    apiEndpoint: string;
-
-    /**
-     * API token.
-     */
-    apiToken: string | null;
-}
-
-const commonInput: DataFetcherInput = {
-    apiEndpoint: GITBOOK_API_URL,
-    apiToken: GITBOOK_API_TOKEN,
-};
-
-/**
- * Create a data fetcher using an API token.
- * The data are being cached by Next.js built-in cache.
- */
-export function createDataFetcher(input: DataFetcherInput = commonInput): GitBookDataFetcher {
-    return {
-        apiEndpoint: input.apiEndpoint,
-
-        async api() {
-            return getAPI(input);
-        },
-
-        withToken({ apiToken }) {
-            return createDataFetcher({
-                ...input,
-                apiToken,
-            });
-        },
-
-        //
-        // API that are tied to the token
-        //
-        getPublishedContentSite(params) {
-            return 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,
-            });
-        },
-        getRevision(params) {
-            return 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,
-            });
-        },
-        getRevisionFile(params) {
-            return 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,
-            });
-        },
-        getReusableContent(params) {
-            return getReusableContent(input, {
-                spaceId: params.spaceId,
-                revisionId: params.revisionId,
-                reusableContentId: params.reusableContentId,
-            });
-        },
-        getLatestOpenAPISpecVersionContent(params) {
-            return getLatestOpenAPISpecVersionContent(input, {
-                organizationId: params.organizationId,
-                slug: params.slug,
-            });
-        },
-        getSpace(params) {
-            return getSpace(input, {
-                spaceId: params.spaceId,
-                shareKey: params.shareKey,
-            });
-        },
-        getChangeRequest(params) {
-            return getChangeRequest(input, {
-                spaceId: params.spaceId,
-                changeRequestId: params.changeRequestId,
-            });
-        },
-        getDocument(params) {
-            return getDocument(input, {
-                spaceId: params.spaceId,
-                documentId: params.documentId,
-            });
-        },
-        getComputedDocument(params) {
-            return getComputedDocument(input, {
-                organizationId: params.organizationId,
-                spaceId: params.spaceId,
-                source: params.source,
-            });
-        },
-        getEmbedByUrl(params) {
-            return getEmbedByUrl(input, {
-                url: params.url,
-                spaceId: params.spaceId,
-            });
-        },
-        searchSiteContent(params) {
-            return searchSiteContent(input, params);
-        },
-
-        //
-        // API that are not tied to the token
-        // where the data is the same for all users
-        //
-        getUserById(userId) {
-            return getUserById(commonInput, userId);
-        },
-        getPublishedContentByUrl(params) {
-            return getPublishedContentByUrl(commonInput, {
-                url: params.url,
-                visitorAuthToken: params.visitorAuthToken,
-                redirectOnError: params.redirectOnError,
-            });
-        },
-    };
-}
-
-async function getUserById(input: DataFetcherInput, userId: string) {
-    'use cache';
-
-    cacheLife('days');
-
-    return wrapDataFetcherError(async () => {
-        const res = await getAPI(input).users.getUserById(userId);
-        return res.data;
-    });
-}
-
-async function getSpace(
-    input: DataFetcherInput,
-    params: {
-        spaceId: string;
-        shareKey: string | undefined;
-    }
-) {
-    'use cache';
-
-    cacheLife('days');
-    cacheTag(
-        getCacheTag({
-            tag: 'space',
-            space: params.spaceId,
-        })
-    );
-
-    return wrapDataFetcherError(async () => {
-        const res = await getAPI(input).spaces.getSpaceById(params.spaceId, {
-            shareKey: params.shareKey,
-        });
-        return res.data;
-    });
-}
-
-async function getChangeRequest(
-    input: DataFetcherInput,
-    params: {
-        spaceId: string;
-        changeRequestId: string;
-    }
-) {
-    'use cache';
-
-    cacheLife('minutes');
-
-    return wrapDataFetcherError(async () => {
-        const res = await getAPI(input).spaces.getChangeRequestById(
-            params.spaceId,
-            params.changeRequestId
-        );
-        cacheTag(
-            getCacheTag({
-                tag: 'change-request',
-                space: params.spaceId,
-                changeRequest: res.data.id,
-            })
-        );
-        return res.data;
-    });
-}
-
-async function getRevision(
-    input: DataFetcherInput,
-    params: {
-        spaceId: string;
-        revisionId: string;
-        metadata: boolean;
-    }
-) {
-    'use cache';
-
-    cacheLife('max');
-
-    return wrapDataFetcherError(async () => {
-        const res = await getAPI(input).spaces.getRevisionById(params.spaceId, params.revisionId, {
-            metadata: params.metadata,
-        });
-        return res.data;
-    });
-}
-
-async function getRevisionPages(
-    input: DataFetcherInput,
-    params: {
-        spaceId: string;
-        revisionId: string;
-        metadata: boolean;
-    }
-) {
-    'use cache';
-
-    cacheLife('max');
-
-    return wrapDataFetcherError(async () => {
-        const res = await getAPI(input).spaces.listPagesInRevisionById(
-            params.spaceId,
-            params.revisionId,
-            {
-                metadata: params.metadata,
-            }
-        );
-        return res.data.pages;
-    });
-}
-
-async function getRevisionFile(
-    input: DataFetcherInput,
-    params: {
-        spaceId: string;
-        revisionId: string;
-        fileId: string;
-    }
-) {
-    'use cache';
-
-    cacheLife('max');
-
-    return wrapDataFetcherError(async () => {
-        const res = await getAPI(input).spaces.getFileInRevisionById(
-            params.spaceId,
-            params.revisionId,
-            params.fileId
-        );
-        return res.data;
-    });
-}
-
-async function getRevisionPageByPath(
-    input: DataFetcherInput,
-    params: {
-        spaceId: string;
-        revisionId: string;
-        path: string;
-    }
-) {
-    'use cache';
-
-    cacheLife('max');
-
-    const encodedPath = encodeURIComponent(params.path);
-    return wrapDataFetcherError(async () => {
-        const res = await getAPI(input).spaces.getPageInRevisionByPath(
-            params.spaceId,
-            params.revisionId,
-            encodedPath
-        );
-
-        return res.data;
-    });
-}
-
-async function getDocument(
-    input: DataFetcherInput,
-    params: {
-        spaceId: string;
-        documentId: string;
-    }
-) {
-    'use cache';
-
-    cacheLife('max');
-
-    return wrapDataFetcherError(async () => {
-        const res = await getAPI(input).spaces.getDocumentById(params.spaceId, params.documentId);
-        return res.data;
-    });
-}
-
-async function getComputedDocument(
-    input: DataFetcherInput,
-    params: {
-        spaceId: string;
-        organizationId: string;
-        source: ComputedContentSource;
-    }
-) {
-    'use cache';
-
-    cacheLife('days');
-
-    cacheTag(
-        ...getComputedContentSourceCacheTags(
-            {
-                spaceId: params.spaceId,
-                organizationId: params.organizationId,
-            },
-            params.source
-        )
-    );
-
-    return wrapDataFetcherError(async () => {
-        const res = await getAPI(input).spaces.getComputedDocument(params.spaceId, {
-            source: params.source,
-        });
-        return res.data;
-    });
-}
-
-async function getReusableContent(
-    input: DataFetcherInput,
-    params: {
-        spaceId: string;
-        revisionId: string;
-        reusableContentId: string;
-    }
-) {
-    'use cache';
-
-    cacheLife('max');
-
-    return wrapDataFetcherError(async () => {
-        const res = await getAPI(input).spaces.getReusableContentInRevisionById(
-            params.spaceId,
-            params.revisionId,
-            params.reusableContentId
-        );
-        return res.data;
-    });
-}
-
-async function getLatestOpenAPISpecVersionContent(
-    input: DataFetcherInput,
-    params: {
-        organizationId: string;
-        slug: string;
-    }
-) {
-    'use cache';
-
-    cacheTag(
-        getCacheTag({
-            tag: 'openapi',
-            organization: params.organizationId,
-            openAPISpec: params.slug,
-        })
-    );
-    cacheLife('days');
-
-    return wrapDataFetcherError(async () => {
-        const res = await getAPI(input).orgs.getLatestOpenApiSpecVersionContent(
-            params.organizationId,
-            params.slug
-        );
-        return res.data;
-    });
-}
-
-async function getPublishedContentByUrl(
-    input: DataFetcherInput,
-    params: {
-        url: string;
-        visitorAuthToken: string | null;
-        redirectOnError: boolean;
-    }
-) {
-    'use cache';
-
-    const { url, visitorAuthToken, redirectOnError } = params;
-
-    const hostname = new URL(url).hostname;
-    cacheTag(
-        getCacheTag({
-            tag: 'url',
-            hostname,
-        })
-    );
-    cacheLife('days');
-
-    return wrapDataFetcherError(async () => {
-        const res = await getAPI(input).urls.getPublishedContentByUrl({
-            url,
-            visitorAuthToken: visitorAuthToken ?? undefined,
-            redirectOnError,
-        });
-
-        if ('site' in res.data) {
-            cacheTag(
-                getCacheTag({
-                    tag: 'site',
-                    site: res.data.site,
-                })
-            );
-        }
-
-        return res.data;
-    });
-}
-
-async function getPublishedContentSite(
-    input: DataFetcherInput,
-    params: {
-        organizationId: string;
-        siteId: string;
-        siteShareKey: string | undefined;
-    }
-) {
-    'use cache';
-
-    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,
-            }
-        );
-        return res.data;
-    });
-}
-
-async function getSiteRedirectBySource(
-    input: DataFetcherInput,
-    params: {
-        organizationId: string;
-        siteId: string;
-        siteShareKey: string | undefined;
-        source: string;
-    }
-) {
-    'use cache';
-
-    cacheTag(
-        getCacheTag({
-            tag: 'site',
-            site: params.siteId,
-        })
-    );
-    cacheLife('days');
-
-    return wrapDataFetcherError(async () => {
-        const res = await getAPI(input).orgs.getSiteRedirectBySource(
-            params.organizationId,
-            params.siteId,
-            {
-                shareKey: params.siteShareKey,
-                source: params.source,
-            }
-        );
-
-        return res.data;
-    });
-}
-
-async function getEmbedByUrl(
-    input: DataFetcherInput,
-    params: {
-        url: string;
-        spaceId: string;
-    }
-) {
-    'use cache';
-
-    cacheLife('weeks');
-
-    return wrapDataFetcherError(async () => {
-        const api = getAPI(input);
-        const res = await api.spaces.getEmbedByUrlInSpace(params.spaceId, { url: params.url });
-        return res.data;
-    });
-}
-
-async function searchSiteContent(
-    input: DataFetcherInput,
-    params: Parameters<GitBookDataFetcher['searchSiteContent']>[0]
-) {
-    'use cache';
-
-    const { organizationId, siteId, query, scope } = params;
-
-    cacheLife('days');
-
-    return wrapDataFetcherError(async () => {
-        const res = await getAPI(input).orgs.searchSiteContent(organizationId, siteId, {
-            query,
-            ...scope,
-        });
-        return res.data.items;
-    });
-}
-
-function getAPI(input: DataFetcherInput) {
-    const { apiEndpoint, apiToken } = input;
-    const api = new GitBookAPI({
-        authToken: apiToken ?? undefined,
-        endpoint: apiEndpoint,
-        userAgent: GITBOOK_USER_AGENT,
-    });
-
-    return api;
-}

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

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

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

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

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

@@ -1,243 +0,0 @@
-import 'server-only';
-
-import { GITBOOK_IMAGE_RESIZE_SIGNING_KEY, GITBOOK_IMAGE_RESIZE_URL } from '../env';
-import type { GitBookSpaceLinker } from '../links';
-import { type SignatureVersion, generateImageSignature } from './signatures';
-import type { ImageResizer } from './types';
-
-interface CloudflareImageJsonFormat {
-    width: number;
-    height: number;
-    original: {
-        file_size: number;
-        width: number;
-        height: number;
-        format: string;
-    };
-}
-
-/**
- * https://developers.cloudflare.com/images/image-resizing/resize-with-workers/
- */
-export interface CloudflareImageOptions {
-    format?: 'webp' | 'avif' | 'json' | 'jpeg';
-    fit?: 'scale-down' | 'contain' | 'cover' | 'crop' | 'pad';
-    width?: number;
-    height?: number;
-    dpr?: number;
-    anim?: boolean;
-    quality?: number;
-}
-
-/**
- * Create an image resizer for a rendering context.
- */
-export function createImageResizer({
-    host,
-    linker,
-}: {
-    /** The linker to use to create URLs. */
-    linker: GitBookSpaceLinker;
-    /** The host name of the current site. */
-    host: string;
-}): ImageResizer {
-    if (!GITBOOK_IMAGE_RESIZE_URL || !GITBOOK_IMAGE_RESIZE_SIGNING_KEY) {
-        return createNoopImageResizer();
-    }
-
-    return {
-        getResizedImageURL: (urlInput) => {
-            if (!checkIsSizableImageURL(urlInput)) {
-                return null;
-            }
-
-            let cachedSignature: {
-                signature: string;
-                version: SignatureVersion;
-            } | null = null;
-
-            return async (options) => {
-                cachedSignature ??= await generateImageSignature({
-                    host,
-                    url: urlInput,
-                });
-
-                const url = linker.toAbsoluteURL(linker.toPathInContent('/~gitbook/image'));
-                const searchParams = new URLSearchParams();
-                searchParams.set('url', getImageAPIUrl(urlInput));
-
-                if (options.width) {
-                    searchParams.set('width', options.width.toString());
-                }
-                if (options.height) {
-                    searchParams.set('height', options.height.toString());
-                }
-                if (options.dpr) {
-                    searchParams.set('dpr', options.dpr.toString());
-                }
-                if (options.quality) {
-                    searchParams.set('quality', options.quality.toString());
-                }
-
-                searchParams.set('sign', cachedSignature.signature);
-                searchParams.set('sv', cachedSignature.version);
-
-                return `${url}?${searchParams.toString()}`;
-            };
-        },
-
-        getImageSize: async (input, options) => {
-            if (!checkIsSizableImageURL(input)) {
-                return null;
-            }
-
-            return getImageSize(input, options);
-        },
-    };
-}
-
-/**
- * Create an image resizer that doesn't do any resizing.
- */
-export function createNoopImageResizer(): ImageResizer {
-    return {
-        getResizedImageURL: () => null,
-        getImageSize: async (_input) => null,
-    };
-}
-
-/**
- * Check if a URL is an HTTP URL.
- */
-export function checkIsHttpURL(input: string | URL): boolean {
-    if (!URL.canParse(input)) {
-        return false;
-    }
-    const parsed = new URL(input);
-    return parsed.protocol === 'http:' || parsed.protocol === 'https:';
-}
-
-/**
- * Check if an image URL is resizable.
- * Skip it for non-http(s) URLs (data, etc).
- * Skip it for SVGs.
- * Skip it for GitBook images (to avoid recursion).
- */
-export function checkIsSizableImageURL(input: string): boolean {
-    if (!URL.canParse(input)) {
-        return false;
-    }
-
-    if (input.includes('/~gitbook/image')) {
-        return false;
-    }
-
-    const parsed = new URL(input);
-    if (parsed.pathname.endsWith('.svg') || parsed.pathname.endsWith('.avif')) {
-        return false;
-    }
-    if (!checkIsHttpURL(parsed)) {
-        return false;
-    }
-
-    return true;
-}
-
-/**
- * Get the size of an image.
- */
-export async function getImageSize(
-    input: string,
-    defaultSize: Partial<CloudflareImageOptions> = {}
-): Promise<{ width: number; height: number } | null> {
-    if (!checkIsSizableImageURL(input)) {
-        return null;
-    }
-
-    try {
-        const response = await resizeImage(input, {
-            // Abort the request after 2 seconds to avoid blocking rendering for too long
-            signal: AbortSignal.timeout(2000),
-            // Measure size and resize it to the most common size
-            // to optimize caching
-            ...defaultSize,
-            format: 'json',
-            anim: false,
-        });
-
-        const json = (await response.json()) as CloudflareImageJsonFormat;
-        return {
-            width: json.original.width,
-            height: json.original.height,
-        };
-    } catch (_error) {
-        return null;
-    }
-}
-
-/**
- * Execute a Cloudflare Image Resize operation on an image.
- */
-export async function resizeImage(
-    input: string,
-    options: CloudflareImageOptions & {
-        signal?: AbortSignal;
-    }
-): Promise<Response> {
-    const { signal, ...resizeOptions } = options;
-
-    const parsed = new URL(input);
-    if (parsed.protocol === 'data:') {
-        throw new Error('Cannot resize data: URLs');
-    }
-
-    if (parsed.hostname === 'localhost') {
-        throw new Error('Cannot resize localhost URLs');
-    }
-
-    // Since Cloudflare Images options on fetch are not supported on Cloudflare Pages,
-    // we need to use the Cloudflare Image Resize API directly.
-    if (!GITBOOK_IMAGE_RESIZE_URL) {
-        throw new Error('GITBOOK_IMAGE_RESIZE_URL is not set');
-    }
-
-    return await fetch(
-        `${GITBOOK_IMAGE_RESIZE_URL}${stringifyOptions(
-            resizeOptions
-        )}/${encodeURIComponent(input)}`,
-        {
-            headers: {
-                // Pass the `Accept` header, as Cloudflare uses this to validate the format.
-                Accept:
-                    resizeOptions.format === 'json'
-                        ? 'application/json'
-                        : `image/${resizeOptions.format || 'jpeg'}`,
-            },
-            signal,
-        }
-    );
-}
-
-function stringifyOptions(options: CloudflareImageOptions): string {
-    return Object.entries({ ...options }).reduce((rest, [key, value]) => {
-        return `${rest}${rest ? ',' : ''}${key}=${value}`;
-    }, '');
-}
-
-/**
- * Because of a bug in Cloudflare, 127.0.0.1 is replaced by localhost.
- * We protect against it by converting to a special token, and then parsing
- * the token in the image API.
- */
-const GITBOOK_LOCALHOST_TOKEN = '$GITBOOK_LOCALHOST$';
-
-/**
- * Prepare a URL for the GitBook Open Image API.
- */
-export function getImageAPIUrl(url: string): string {
-    return url.replaceAll('127.0.0.1', GITBOOK_LOCALHOST_TOKEN);
-}
-
-export function parseImageAPIURL(url: string): string {
-    return url.replaceAll(GITBOOK_LOCALHOST_TOKEN, '127.0.0.1');
-}

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

@@ -1,58 +0,0 @@
-import { describe, expect, it } from 'bun:test';
-import { appendBasePathToLinker, createLinker } from './links';
-
-const root = createLinker({
-    host: 'docs.company.com',
-    pathname: '/',
-});
-
-const variantInSection = createLinker({
-    host: 'docs.company.com',
-    pathname: '/section/variant',
-});
-
-describe('toPathInContent', () => {
-    it('should return the correct path', () => {
-        expect(root.toPathInContent('some/path')).toBe('/some/path');
-        expect(variantInSection.toPathInContent('some/path')).toBe('/section/variant/some/path');
-    });
-
-    it('should handle leading slash', () => {
-        expect(root.toPathInContent('/some/path')).toBe('/some/path');
-        expect(variantInSection.toPathInContent('/some/path')).toBe('/section/variant/some/path');
-    });
-});
-
-describe('toAbsoluteURL', () => {
-    it('should return the correct path', () => {
-        expect(root.toAbsoluteURL('some/path')).toBe('https://docs.company.com/some/path');
-        expect(variantInSection.toAbsoluteURL('some/path')).toBe(
-            'https://docs.company.com/some/path'
-        );
-    });
-});
-
-describe('appendBasePathToLinker', () => {
-    const prefixedRoot = appendBasePathToLinker(root, '/section/variant');
-    const prefixedVariantInSection = appendBasePathToLinker(variantInSection, '/base');
-
-    describe('toPathInContent', () => {
-        it('should return the correct path', () => {
-            expect(prefixedRoot.toPathInContent('some/path')).toBe('/section/variant/some/path');
-            expect(prefixedVariantInSection.toPathInContent('some/path')).toBe(
-                '/section/variant/base/some/path'
-            );
-        });
-    });
-
-    describe('toAbsoluteURL', () => {
-        it('should return the correct path', () => {
-            expect(prefixedRoot.toAbsoluteURL('some/path')).toBe(
-                'https://docs.company.com/some/path'
-            );
-            expect(prefixedVariantInSection.toAbsoluteURL('some/path')).toBe(
-                'https://docs.company.com/some/path'
-            );
-        });
-    });
-});

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

@@ -1,116 +0,0 @@
-import { getPagePath } from '@/lib/pages';
-import type { RevisionPage, RevisionPageDocument, RevisionPageGroup } from '@gitbook/api';
-import warnOnce from 'warn-once';
-
-/**
- * Generic interface to generate links based on a given context.
- *
- * URL levels:
- *
- * https://docs.company.com/section/variant/page
- *
- * toPathInContent('some/path') => /section/variant/some/path
- * toPathForPage({ pages, page }) => /section/variant/some/path
- * toAbsoluteURL('some/path') => https://docs.company.com/some/path
- */
-export interface GitBookSpaceLinker {
-    /**
-     * Generate an absolute path for a relative path to the current content.
-     */
-    toPathInContent(relativePath: string): string;
-
-    /**
-     * Generate an absolute path for a page in the current content.
-     * The result should NOT be passed to `toPathInContent`.
-     */
-    toPathForPage(input: {
-        pages: RevisionPage[];
-        page: RevisionPageDocument | RevisionPageGroup;
-        anchor?: string;
-    }): string;
-
-    /**
-     * Generate an absolute URL for a given path relative to the host of the current content.
-     */
-    toAbsoluteURL(absolutePath: string): string;
-
-    /**
-     * Generate a link (URL or path) for a GitBook content URL (url of another site)
-     */
-    toLinkForContent(url: string): string;
-}
-
-/**
- * Create a linker to resolve links in a context being served on a specific URL.
- */
-export function createLinker(
-    /** Where the top of the space is served on */
-    servedOn: {
-        protocol?: string;
-        host?: string;
-        pathname: string;
-    }
-): GitBookSpaceLinker {
-    warnOnce(!servedOn.host, 'No host provided to createLinker. It can lead to issues with links.');
-
-    const linker: GitBookSpaceLinker = {
-        toPathInContent(relativePath: string): string {
-            return joinPaths(servedOn.pathname, relativePath);
-        },
-
-        toAbsoluteURL(absolutePath: string): string {
-            if (!servedOn.host) {
-                return absolutePath;
-            }
-
-            return `${servedOn.protocol ?? 'https:'}//${joinPaths(servedOn.host, absolutePath)}`;
-        },
-
-        toPathForPage({ pages, page, anchor }) {
-            return linker.toPathInContent(getPagePath(pages, page)) + (anchor ? `#${anchor}` : '');
-        },
-
-        toLinkForContent(url: string): string {
-            return url;
-        },
-    };
-
-    return linker;
-}
-
-/**
- * Append a prefix to a linker.
- */
-export function appendBasePathToLinker(
-    linker: GitBookSpaceLinker,
-    basePath: string
-): GitBookSpaceLinker {
-    const linkerWithPrefix: GitBookSpaceLinker = {
-        toPathInContent(relativePath: string): string {
-            return linker.toPathInContent(joinPaths(basePath, relativePath));
-        },
-
-        toAbsoluteURL(absolutePath: string): string {
-            return linker.toAbsoluteURL(absolutePath);
-        },
-
-        toPathForPage({ pages, page, anchor }) {
-            return (
-                linkerWithPrefix.toPathInContent(getPagePath(pages, page)) +
-                (anchor ? `#${anchor}` : '')
-            );
-        },
-
-        toLinkForContent(url: string): string {
-            return linker.toLinkForContent(url);
-        },
-    };
-
-    return linkerWithPrefix;
-}
-
-function joinPaths(prefix: string, path: string): string {
-    const prefixPath = prefix.endsWith('/') ? prefix : `${prefix}/`;
-    const suffixPath = path.startsWith('/') ? path.slice(1) : path;
-    return prefixPath + suffixPath;
-}

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

@@ -1,134 +0,0 @@
-import { CustomizationThemeMode, type PublishedSiteContent } from '@gitbook/api';
-import { headers } from 'next/headers';
-
-export enum MiddlewareHeaders {
-    /**
-     * Type of the route (static or dynamic)
-     */
-    RouteType = 'x-gitbook-route-type',
-
-    /**
-     * The URL of the site (without the pathname)
-     */
-    SiteURL = 'x-gitbook-site-url',
-
-    /**
-     * The data associated with the URL.
-     */
-    SiteURLData = 'x-gitbook-site-url-data',
-
-    /**
-     * The mode of the URL (url or url-host)
-     */
-    URLMode = 'x-gitbook-url-mode',
-
-    /**
-     * The theme of the page (light or dark)
-     */
-    Theme = 'x-gitbook-theme',
-
-    /**
-     * The customization override to apply.
-     */
-    Customization = 'x-gitbook-customization',
-
-    /**
-     * The 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',
-}
-
-/**
- * Get the URL mode from the middleware headers.
- * This function should only be called in a server action or a dynamic route.
- */
-export async function getURLModeFromMiddleware(): Promise<'url' | 'url-host'> {
-    const headersList = await headers();
-    const mode = headersList.get(MiddlewareHeaders.URLMode);
-    if (!mode) {
-        throw new Error('URL mode is not set by the middleware');
-    }
-
-    return mode as 'url' | 'url-host';
-}
-
-/**
- * Get the site URL data from the middleware headers.
- * This function should only be called in a server action or a dynamic route.
- */
-export async function getSiteURLDataFromMiddleware(): Promise<PublishedSiteContent> {
-    const headersList = await headers();
-    const siteURLData = headersList.get(MiddlewareHeaders.SiteURLData);
-
-    if (!siteURLData) {
-        throw new Error(
-            'Site URL data is not set by the middleware. This should only be called in a server action or a dynamic route.'
-        );
-    }
-
-    return JSON.parse(siteURLData);
-}
-
-/**
- * Get the URL from the middleware headers.
- * This function should only be called in a server action or a dynamic route.
- */
-export async function getSiteURLFromMiddleware(): Promise<string> {
-    const headersList = await headers();
-    const siteURL = headersList.get(MiddlewareHeaders.SiteURL);
-    if (!siteURL) {
-        throw new Error('URL mode is not set by the middleware');
-    }
-
-    return siteURL;
-}
-
-/**
- * For preview, the theme can be set via query string (?theme=light).
- * This function should only be called in a dynamic route.
- */
-export async function getThemeFromMiddleware() {
-    const headersList = await headers();
-    const queryStringTheme = headersList.get(MiddlewareHeaders.Theme);
-    if (!queryStringTheme) {
-        return null;
-    }
-
-    return queryStringTheme === 'light'
-        ? CustomizationThemeMode.Light
-        : CustomizationThemeMode.Dark;
-}
-
-/**
- * Get the visitor auth token from the middleware headers.
- * This function should only be called in a dynamic route.
- */
-export async function getVisitorAuthTokenFromMiddleware(): Promise<string | null> {
-    const headersList = await headers();
-    const visitorAuthToken = headersList.get(MiddlewareHeaders.VisitorAuthToken);
-    if (!visitorAuthToken) {
-        return 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,379 +0,0 @@
-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 {
-    type ResponseCookies,
-    getPathScopedCookieName,
-    getResponseCookiesForVisitorAuth,
-    getVisitorToken,
-    normalizeVisitorAuthURL,
-} from '@/lib/visitor-token';
-import { serveResizedImage } from '@/routes/image';
-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';
-
-export const config = {
-    matcher: [
-        '/((?!_next/static|_next/image|~gitbook/static|~gitbook/revalidate|~gitbook/monitoring|~scalar/proxy).*)',
-    ],
-};
-
-type URLWithMode = { url: URL; mode: 'url' | 'url-host' };
-
-export async function middleware(request: NextRequest) {
-    try {
-        const requestURL = new URL(request.url);
-
-        // 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;
-            }
-        }
-
-        return NextResponse.next();
-    } catch (error) {
-        return serveErrorResponse(error as Error);
-    }
-}
-
-/**
- * Handle request that are targetting the site routes group.
- */
-async function serveSiteRoutes(requestURL: URL, request: NextRequest) {
-    const match = getSiteURLFromRequest(request);
-    if (!match) {
-        return null;
-    }
-
-    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, `${siteURL.origin}${data.basePath}`);
-    requestHeaders.set(MiddlewareHeaders.SiteURLData, JSON.stringify(data));
-
-    // Preview of customization/theme
-    const customization = siteURL.searchParams.get('customization');
-    if (customization && validateSerializedCustomization(customization)) {
-        routeType = 'dynamic';
-        requestHeaders.set(MiddlewareHeaders.Customization, customization);
-    }
-    const theme = siteURL.searchParams.get('theme');
-    if (theme === CustomizationThemeMode.Dark || theme === CustomizationThemeMode.Light) {
-        routeType = 'dynamic';
-        requestHeaders.set(MiddlewareHeaders.Theme, theme);
-    }
-
-    // We support forcing dynamic routes by setting a `gitbook-dynamic-route` cookie
-    // This is useful for testing dynamic routes.
-    if (request.cookies.has('gitbook-dynamic-route')) {
-        routeType = 'dynamic';
-    }
-
-    // Pass a x-forwarded-host and origin that are equal to ensure Next doesn't block server actions when proxied
-    requestHeaders.set('x-forwarded-host', request.nextUrl.host);
-    requestHeaders.set('origin', request.nextUrl.origin);
-
-    const siteURLWithoutProtocol = `${siteURL.host}${data.basePath}`;
-    const { pathname, routeType: routeTypeFromPathname } = encodePathInSiteContent(data.pathname);
-    routeType = routeTypeFromPathname ?? routeType;
-
-    const route = [
-        'sites',
-        routeType,
-        mode,
-        encodeURIComponent(siteURLWithoutProtocol),
-        pathname,
-    ].join('/');
-
-    console.log(`rewriting ${request.nextUrl.toString()} to ${route}`);
-
-    const rewrittenURL = new URL(`/${route}`, request.nextUrl.toString());
-    const response = NextResponse.rewrite(rewrittenURL, {
-        request: {
-            headers: requestHeaders,
-        },
-    });
-
-    // Add Content Security Policy header
-    response.headers.set('content-security-policy', getContentSecurityPolicy());
-    // Basic security headers
-    response.headers.set('strict-transport-security', 'max-age=31536000');
-    response.headers.set('referrer-policy', 'no-referrer-when-downgrade');
-    response.headers.set('x-content-type-options', 'nosniff');
-    // Debug header
-    response.headers.set('x-gitbook-route-type', routeType);
-    response.headers.set('x-gitbook-route-site', siteURLWithoutProtocol);
-
-    return writeResponseCookies(response, cookies);
-}
-
-/**
- * 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;
-    }
-
-    // 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 DataFetcherError) {
-        return new Response(error.message, {
-            status: error.code,
-            headers: { 'content-type': 'text/plain' },
-        });
-    }
-
-    throw error;
-}
-
-/**
- * The URL of the GitBook content can be passed in 3 different ways (in order of priority):
- * - The request has a `X-GitBook-URL` header:
- *      URL is taken from the header.
- * - The request has a `X-Forwarded-Host` header:
- *      Host is taken from the header, pathname is taken from the request URL.
- * - The request URL is matching `/url/:url`:
- *      URL is taken from the pathname.
- */
-function getSiteURLFromRequest(request: NextRequest): URLWithMode | null {
-    const xGitbookUrl = request.headers.get('x-gitbook-url');
-    if (xGitbookUrl) {
-        return {
-            url: appendQueryParams(new URL(xGitbookUrl), request.nextUrl.searchParams),
-            mode: 'url-host',
-        };
-    }
-
-    const isMainHost = isGitBookHostURL(request.url);
-    const isAssetsHost = isGitBookAssetsHostURL(request.url);
-
-    // /url/:url requests on the main host
-    const prefix = '/url/';
-    if (isMainHost && request.nextUrl.pathname.startsWith(prefix)) {
-        return {
-            url: appendQueryParams(
-                new URL(`https://${request.nextUrl.pathname.slice(prefix.length)}`),
-                request.nextUrl.searchParams
-            ),
-            mode: 'url',
-        };
-    }
-
-    // Skip other requests to main hosts
-    if (isMainHost || isAssetsHost) {
-        return null;
-    }
-
-    const xForwardedHost = request.headers.get('x-forwarded-host');
-    // The x-forwarded-host is set by Vercel for all requests
-    // so we ignore it if the hostname is the same as the instance one.
-    if (xForwardedHost) {
-        return {
-            url: appendQueryParams(
-                new URL(`https://${xForwardedHost}${request.nextUrl.pathname}`),
-                request.nextUrl.searchParams
-            ),
-            mode: 'url-host',
-        };
-    }
-
-    return null;
-}
-
-/**
- * Encode path in a site content.
- * Special paths are not encoded and passed to be handled by the route handlers.
- */
-function encodePathInSiteContent(rawPathname: string): {
-    pathname: string;
-    routeType?: 'static' | 'dynamic';
-} {
-    const pathname = removeLeadingSlash(removeTrailingSlash(rawPathname));
-
-    if (pathname.match(/^~gitbook\/ogimage\/\S+$/)) {
-        return { pathname };
-    }
-
-    switch (pathname) {
-        case '~gitbook/icon':
-        case 'llms.txt':
-        case 'sitemap.xml':
-        case 'robots.txt':
-            return { pathname };
-        case '~gitbook/pdf':
-            // PDF routes are always dynamic as they depend on the search params.
-            return { pathname, routeType: 'dynamic' };
-        default:
-            return { pathname: encodeURIComponent(pathname || '/') };
-    }
-}
-
-/**
- * Append all the query params from a URL to another URL.
- */
-function appendQueryParams(url: URL, from: URLSearchParams) {
-    for (const [key, value] of from.entries()) {
-        url.searchParams.set(key, value);
-    }
-
-    return url;
-}
-
-/**
- * Write the cookies to a response.
- */
-function writeResponseCookies<R extends NextResponse>(response: R, cookies: ResponseCookies): R {
-    Object.entries(cookies).forEach(([key, { value, options }]) => {
-        response.cookies.set(key, value, options);
-    });
-
-    return response;
-}

packages/gitbook-v2/tailwind.config.ts

@@ -1,10 +0,0 @@
-import config from '../gitbook/tailwind.config';
-
-export default {
-    ...config,
-    content: [
-        '../gitbook/src/pages/**/*.{js,ts,jsx,tsx,mdx}',
-        '../gitbook/src/components/**/*.{js,ts,jsx,tsx,mdx}',
-        '../gitbook/src/app/**/*.{js,ts,jsx,tsx,mdx}',
-    ],
-};

packages/gitbook-v2/tsconfig.json

@@ -1,44 +0,0 @@
-{
-    "compilerOptions": {
-        "target": "esnext",
-        "lib": ["dom", "dom.iterable", "esnext"],
-        "allowJs": true,
-        "skipLibCheck": true,
-        "strict": true,
-        "noEmit": true,
-        "incremental": true,
-        "module": "esnext",
-        "esModuleInterop": true,
-        "moduleResolution": "bundler",
-        "resolveJsonModule": true,
-        "isolatedModules": true,
-        "jsx": "preserve",
-        "plugins": [
-            {
-                "name": "next"
-            }
-        ],
-        "paths": {
-            "@v2/*": ["./src/*"],
-            "@/*": ["../gitbook/src/*"]
-        },
-        "types": [
-            "bun-types" // add Bun global
-        ]
-    },
-    "include": [
-        "next-env.d.ts",
-        ".next/types/**/*.ts",
-        "**/*.ts",
-        "**/*.tsx",
-        "../gitbook/types/**/*.d.ts",
-        "../gitbook/cf-env.d.ts"
-    ],
-    "exclude": [
-        "node_modules",
-        "packages/openapi-parser",
-        "packages/react-openapi",
-        "packages/react-math",
-        "packages/gitbook"
-    ]
-}

packages/gitbook-v2/turbo.json

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

packages/gitbook-v2/wrangler.toml

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

packages/gitbook/.env.example

@@ -1,30 +0,0 @@
-# Configurations
-
-### API ###
-
-## API token to use when looking up the published content
-# GITBOOK_API_URL=https://api.gitbook.com
-# GITBOOK_TOKEN=xxx
-
-## User agent to use when making requests to the API
-# GITBOOK_USER_AGENT=GitBook/1.0.0
-# GITBOOK_USER_AGENT_COMMENT=something
-
-### URL of the application ###
-# NEXT_PUBLIC_GITBOOK_APP_URL=https://app.gitbook.com
-
-### Image resizing ###
-# GITBOOK_IMAGE_RESIZE_SIGNING_KEY=1234567890
-# GITBOOK_IMAGE_RESIZE_URL=https://mycompany.com/cdn-cgi/image/
-
-### SEO ###
-# GITBOOK_BLOCK_SEARCH_INDEXATION=true
-
-## Caching
-# GITBOOK_OUTPUT_CACHE=true
-
-### Sentry ###
-# SENTRY_DSN=xxx
-
-### Silent logs
-# SILENT=true

packages/gitbook/.gitignore

@@ -1,3 +1,4 @@
+
 # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
 
 # testing
@@ -23,9 +24,6 @@ next-env.d.ts
 # visual tests
 screenshots/
 
-# Sentry Config File
-.sentryclirc
-
 /test-results/
 /playwright-report/
 /blob-report/
@@ -34,3 +32,8 @@ screenshots/
 # Generated public files
 /public/~gitbook/static/*
 !/public/~gitbook/static/images
+
+# cloudflare
+.open-next
+.wrangler
+worker-configuration.d.ts

packages/gitbook/CHANGELOG.md

@@ -1,5 +1,353 @@
 # gitbook
 
+## 0.13.1
+
+### Patch Changes
+
+- f5894bc: Fix incorrect revision ID in Markdown fetch logic
+- 1b59e7c: Styling improvements to AI Chat Followup questions
+- Updated dependencies [bd553bc]
+  - @gitbook/openapi-parser@2.2.0
+  - @gitbook/react-openapi@1.3.2
+
+## 0.13.0
+
+### Minor Changes
+
+- af98402: Add support for inline icons.
+- 7d3fe23: Add circular corners and depth styling
+- f3affc3: Display MCP tool calls in AI chat.
+- fa12f9e: Support dark-mode specific page cover image
+- df848ef: Add support for icons in buttons.
+- b7a0db3: Fix rendering of ogimage with SVG logos.
+- c3b620e: Best effort at preserving current variant when navigating between sections by matching the pathname against site spaces in the new section.
+- 4fb2a4a: Rework full-width layout, add support for full-width page option
+- df848ef: Add support for text alignment for headings and paragraphs.
+- f033734: Add support for site customization option to change how external links open.
+- 7b38f89: Enable AI chat when AI mode is configured to assistant
+- 8d65983: Add AI chat
+
+### Patch Changes
+
+- 42d88da: Fix UX issue about highlighting the search term in search result sections
+- 6aa3ff9: Fix three small visual issues
+
+  - Fix sidebar showing on `no-toc` pages in the gradient theme
+  - Fix variant selector truncating incorrectly in header when sections are present
+  - Fix page cover alignment on `lg` screens without TOC
+
+- 015615d: Respect fullWidth and defaultWidth for images
+- e8fb84d: Fix hash with align in columns
+- 4721403: Hide scrollbar on sections
+- d410381: Add docs.testgitbook.com to ADAPTIVE_CONTENT_HOSTS list
+- 7d5a6d2: fix nested a tag causing hydration error
+- bc1eca8: Error handling for AI Chat
+- b3a7ad6: fix href being empty in TOC
+- dc4268d: Fix navigation between sections/variants when previewing a site in v2
+- 58d7f3c: Fix revision id for computed content
+- 11a6511: Fix crash when integration script fails to render block.
+- 7a00880: Improve support for OAuth2 security type
+- c0ee60e: Adds Columns layout block to GBO
+- 9316ccd: Update Models page styling
+- 42d43e0: Show scrollbars
+- 72cd0e5: Optimize performances by using a smarter per-request cache arround data cached functions
+- af66ff7: add a force-revalidate api route to force bust the cache in case of errors
+- e2afc07: Fix resolution of page by resolving site redirects before space redirects
+- 88a35ed: Fix crash when integration is triggering invalid requests.
+- 711cf38: Optimize the fetch of revision files by using only the getRevision cache.
+- f58b904: encode customization header
+- 4f5fec7: Fix CodeBlock layout
+- 3bfe347: Show tabs when there is a single section group present
+- a7a713b: Scroll to active TOC when clicking a link
+- ba0094a: fix ISR on preview env
+- 521052d: Fix concurrent execution in Vercel causing pages to not be attached to the proper tags.
+- 33726c8: Generate a llms-full.txt version of the docs site
+- 500c8cb: Don't crash ogimage generation on RTL text, as a workaround until we can support it.
+- 6859f7d: Fix rendering of ogimage when logo or icon are AVIF images.
+- a28a997: Add margin to adjacent buttons
+- 67998b6: Fix ogimage generation failing with some JPEG images.
+- 8c0a53a: Fix page group not expanded by default
+- dfa8a37: Don't cache unexpected API errors for more than a few minutes.
+- 73e0cbb: Fix an issue where PDF export URLs were not keeping their query params.
+- e5bac69: Fix markdown page generation for groups
+- 6294bbb: add a global error boundary
+- b60039b: Fix links to other spaces within a section.
+- 59da30f: Add support for cover repositioning
+- b403962: Handle nullish OpenAPI mediaTypeObject
+- c730845: Fix missing title on button to close the announcement banner.
+- 231167d: Make icons for page groups more contrasting
+- d99da6a: Ignore case while highlighting search results.
+- dae019c: Consistently show variant selector in section bar if site has sections
+- dd65987: Include page group children under the .md route
+- 57bb146: Make TOC height dynamic based on visible header and footer elements
+- 4f7c0ee: Clicking an active TOC item toggles its descendants
+- ca3b9ac: Improve AI Chat context popup
+- 5726999: Fix viewing a page from a revision
+- 392f594: Fix InlineLinkTooltip having a negative impact on performance, especially on larger pages.
+- c9373ef: Fix bold header links hover color
+- fa3eb07: cache fonts and static image used in OGImage in memory
+- e7a591d: Fix border being added to cards
+- 427f748: Add metadata for adding site to Apple devices home
+- a3a944d: Fix crash during rendering of ogimage for VA sites with default icon.
+- 4b67fe5: Add `urlObject.hash` to `linker.toLinkForContent` to pass through URL fragment identifiers, used in search
+- caaa692: Allow to zoom images on mobile if relevant
+- 902c3c6: apply customization for dynamic context
+- b6b5975: Reverse order of feedback smileys
+- fbfcca5: Fix ogimage using incorrect Google Font depending on language.
+- 2932077: remove trailing slash from linker
+- 2350baa: Support for OpenAPI Array request body
+- Updated dependencies [957afd9]
+- Updated dependencies [7a00880]
+- Updated dependencies [11a6511]
+- Updated dependencies [fbfcca5]
+- Updated dependencies [a0c06a7]
+- Updated dependencies [b403962]
+- Updated dependencies [1e013cd]
+- Updated dependencies [4f5cbfe]
+- Updated dependencies [4c9a9d0]
+- Updated dependencies [40df91a]
+- Updated dependencies [2350baa]
+  - @gitbook/react-openapi@1.3.1
+  - @gitbook/react-contentkit@0.7.1
+  - @gitbook/fonts@0.1.0
+  - @gitbook/openapi-parser@2.1.5
+
+## 0.12.0
+
+### Minor Changes
+
+- 8339e91: Fix images in reusable content across spaces.
+- 326e28e: Design tweaks to code blocks and OpenAPI pages
+- 3119066: Add support for reusable content across spaces.
+- 7d7806d: Pass SVG images through image resizing without resizing them to serve them from optimal host.
+
+### Patch Changes
+
+- c4ebb3f: Fix openapi-select hover in responses
+- aed79fd: Decrease rounding of header logo
+- 42ca7e1: Fix openapi CR preview
+- e6ddc0f: Fix URL in sitemap
+- 5e975ab: Fix code highlighting for HTTP
+- 5d504ff: Fix resolution of links in reusable contents
+- 95a1f65: Better print layouts: wrap code blocks & force table column auto-sizing
+- 0499966: Fix invalid sitemap.xml generated with relative URLs instead of absolute ones
+- 2a805cc: Change OpenAPI schema-optional from `info` to `tint` color
+- 580101d: Fix schemas disclosure label causing client error
+- 12a455d: Fix OpenAPI layout issues
+- 97b7c79: Increase logging around caching behaviour causing page crashes.
+- 373f18f: Prevent section group popovers from opening on click
+- 3f29206: Update the regex for validating site redirect
+- 0c973a3: Always link main logo to the root of the site
+- ae5f1ab: Change `Dropdown`s to use Radix's `DropdownMenu`
+- 0e201d5: Add border to filled sidebar on gradient theme
+- dd043df: Revert investigation work around URL caches.
+- 89a5816: Fix OpenAPI disclosure label ("Show properties") misalignment on mobile
+- Updated dependencies [c3f6b8c]
+- Updated dependencies [d00dc8c]
+- Updated dependencies [42ca7e1]
+- Updated dependencies [326e28e]
+- Updated dependencies [5e975ab]
+- Updated dependencies [f7a3470]
+- Updated dependencies [580101d]
+- Updated dependencies [20ebecb]
+- Updated dependencies [80cb52a]
+- Updated dependencies [cb5598d]
+- Updated dependencies [c6637b0]
+- Updated dependencies [a3ec264]
+  - @gitbook/colors@0.3.3
+  - @gitbook/openapi-parser@2.1.4
+  - @gitbook/react-openapi@1.3.0
+
+## 0.11.1
+
+### Patch Changes
+
+- Updated dependencies [ebc39e9]
+- Updated dependencies [b6b09d4]
+  - @gitbook/react-openapi@1.2.1
+
+## 0.11.0
+
+### Minor Changes
+
+- d67699a: Add OpenAPI Webhook block
+
+### Patch Changes
+
+- 4b8a621: Show sections tabs only if there is at least two sections
+- 8ed1bda: Translate OpenAPI blocks
+- 7588cfe: Improve OpenAPIResponses examples and schemas
+- Updated dependencies [eeb977f]
+- Updated dependencies [3363a18]
+- Updated dependencies [d67699a]
+- Updated dependencies [8ed1bda]
+- Updated dependencies [7588cfe]
+- Updated dependencies [ad1dc0b]
+  - @gitbook/react-openapi@1.2.0
+
+## 0.10.1
+
+### Patch Changes
+
+- Updated dependencies [77397ca]
+  - @gitbook/cache-tags@0.3.1
+
+## 0.10.0
+
+### Minor Changes
+
+- b62b101: Do not set cookie to identify visitor for insights when disabled.
+
+### Patch Changes
+
+- 95ea22d: Cache AI Page Link summary
+- daf41fc: Tweak footer design (and refactor)
+- de53946: Fix security issue with injection of "javacript:` url in the back button of PDFs
+- b92ecfa: Implement retry logic for the DO cache to prevent when revalidating content.
+- 528eee3: Add superscript and subscript text rendering
+- aa3357a: Fix OpenAPISchemas description padding
+- 168a4fa: Add support for buttons to GitBook.
+- 70c4182: Improve OpenAPI schema style
+- 2b6c593: Remove stable from x-stability
+- 580f7ad: Improve the error message returned by the revalidate endpoint.
+- cbd768a: Improve OpenAPI codesample (add OpenAPISelect component)
+- c765463: Fix ogimage generation crashing when site is using a custom WOFF2 font
+- e59076a: Improve OpenAPI schemas block ungrouped style. Classnames have changed, please refer to this PR to update GBX.
+- 29aaba5: Override Scalar's overscroll-behavior
+- 90ead98: Better error handling in cache revalidation.
+- Updated dependencies [116575c]
+- Updated dependencies [cdffd7c]
+- Updated dependencies [70c4182]
+- Updated dependencies [2b6c593]
+- Updated dependencies [cbd768a]
+- Updated dependencies [e59076a]
+- Updated dependencies [eedefdd]
+- Updated dependencies [23cedd2]
+  - @gitbook/cache-tags@0.3.0
+  - @gitbook/colors@0.3.2
+  - @gitbook/react-openapi@1.1.10
+  - @gitbook/openapi-parser@2.1.3
+
+## 0.9.2
+
+### Patch Changes
+
+- da7b369: Fix missing headers in OpenAPIResponses
+- 139a805: Fix OpenAPI enum display
+- Updated dependencies [da7b369]
+- Updated dependencies [da485f5]
+- Updated dependencies [139a805]
+  - @gitbook/react-openapi@1.1.9
+
+## 0.9.1
+
+### Patch Changes
+
+- fb90eb0: Limit tinted background on bold theme to sites with filled sidebar
+- 7d0b422: Handle grouped OpenAPISchemas
+- Updated dependencies [7d0b422]
+- Updated dependencies [fb90eb0]
+  - @gitbook/react-openapi@1.1.8
+  - @gitbook/colors@0.3.1
+
+## 0.9.0
+
+### Minor Changes
+
+- 77fd393: Track event when visitor is opening a search result.
+- d70d566: Support site announcement banner
+- 77fd393: Track event when clicking announcement banner link.
+
+### Patch Changes
+
+- e84a46a: Fix OpenAPI tabs indicator overflow
+- bc90adb: Fix favicon not being displayed in Google because `robots.txt` was preventing the indexation of the image route
+- 434af90: Fix image resizing when using the proxy feature in a site.
+- c756761: Add breadcrumbs to search results
+- 40e8e69: Disallow crawling by web-robots of search/ask URLs
+- 77fd393: Fix clicking search results when the site is embedded in an iframe.
+- 1505ddb: Fix multiple request examples selector not showing
+- 61db166: Add OpenAPI write-only indicator
+- 6f71da8: Fix padding in schemas
+- fa91eb7: Fix PDF generation when user has dark mode configured.
+- 5b1e01c: Support for x-stability property
+- 57ca4e0: Fix a crash when a page contains a block of an integration that is no longer installed
+- d236bf0: Fix flash when loading sites with dark mode as default theme
+- cd99ed5: Fix spec properties rendering and missing keys
+- 813b2af: Support for x-enumDescriptions and x-gitbook-enum
+- e9fa50d: Trim the search query to avoid showing a loading state when typing
+- Updated dependencies [bd35348]
+- Updated dependencies [ae78fc5]
+- Updated dependencies [7bb37c7]
+- Updated dependencies [373183a]
+- Updated dependencies [1505ddb]
+- Updated dependencies [61db166]
+- Updated dependencies [5b1e01c]
+- Updated dependencies [cd99ed5]
+- Updated dependencies [813b2af]
+- Updated dependencies [a25fded]
+  - @gitbook/react-openapi@1.1.7
+  - @gitbook/openapi-parser@2.1.2
+
+## 0.8.2
+
+### Patch Changes
+
+- ed07206: Fix OpenAPI path overflow on mobile
+- 4dab1c5: Fix alignment of `prominent` search bar on full-width pages
+- 6eae764: Support body examples
+- 54ee014: Add initial support for loading custom fonts
+- d2facb2: Mark properties as optional if not required
+- bba2e52: Fix site redirects when it includes a section/variant path
+- 4723f03: Restyle section group dropdown
+- 24b7808: Fix `prominent` search bar width on `md` screens
+- 1fe3286: Fix OpenAPI block overflow issue
+- Updated dependencies [48c18c0]
+- Updated dependencies [6eae764]
+- Updated dependencies [7212973]
+- Updated dependencies [d2facb2]
+- Updated dependencies [73e2b47]
+- Updated dependencies [70be2c6]
+- Updated dependencies [fc00b51]
+- Updated dependencies [a84b06b]
+  - @gitbook/openapi-parser@2.1.1
+  - @gitbook/react-openapi@1.1.6
+
+## 0.8.1
+
+### Patch Changes
+
+- 886e204: Update OpenAPI operation path design
+- Updated dependencies [886e204]
+- Updated dependencies [4f0a772]
+  - @gitbook/react-openapi@1.1.5
+  - @gitbook/colors@0.3.0
+
+## 0.8.0
+
+### Minor Changes
+
+- eec3eed: Add styling for prominent search bar option
+
+### Patch Changes
+
+- 16292de: Display sidebar on no-TOC pages
+- 9b5f971: Transparent background for OpenAPI path block
+- 99da8df: Optimize favicons and og:image using the image resizer
+- b011ea0: Fix rendering of code blocks in Ask AI when being streamed
+- 9bc3d50: Info hint background and link color fixes
+- 31d800e: Render OpenAPISchemas block
+- Updated dependencies [6aaeae2]
+- Updated dependencies [c60e9ba]
+- Updated dependencies [9108c56]
+- Updated dependencies [31d800e]
+- Updated dependencies [ff3b708]
+- Updated dependencies [f32bf1f]
+- Updated dependencies [c9ea239]
+  - @gitbook/react-contentkit@0.7.0
+  - @gitbook/react-openapi@1.1.4
+  - @gitbook/cache-tags@0.2.0
+
 ## 0.7.3
 
 ### Patch Changes
@@ -374,7 +722,7 @@
 - 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
+- 5096f7f: Disable KV cache for gitbook.com/docs 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`

packages/gitbook/_routes.json

@@ -1,4 +0,0 @@
-{
-    "version": 1,
-    "exclude": ["/~gitbook/static/*"]
-}

packages/gitbook/cf-env.d.ts

@@ -1,7 +0,0 @@
-import type { CacheObject } from '@gitbook/cache-do';
-
-declare global {
-    interface CloudflareEnv {
-        CACHE?: DurableObjectNamespace<CacheObject>;
-    }
-}

packages/gitbook/e2e/customers.spec.ts

@@ -1,4 +1,4 @@
-import { type TestsCase, runTestCases } from './util';
+import { type TestsCase, runTestCases, waitForCookiesDialog } from './util';
 
 /** A list of test cases to run on the customers' docs sites. */
 const testCases: TestsCase[] = [
@@ -6,15 +6,22 @@ const testCases: TestsCase[] = [
         name: 'Snyk',
         contentBaseURL: 'https://docs.snyk.io',
         tests: [
-            { name: 'Home', url: '/' },
+            { name: 'Home', url: '/', run: waitForCookiesDialog },
-            { name: 'OpenAPI', url: '/snyk-api/reference/apps' },
+            { name: 'OpenAPI', url: '/snyk-api/reference/apps', run: waitForCookiesDialog },
         ],
     },
-    {
+    // {
-        name: 'Nexthink',
+    //     name: 'Nexthink',
-        contentBaseURL: 'https://docs.nexthink.com',
+    //     contentBaseURL: 'https://docs.nexthink.com',
-        tests: [{ name: 'Home', url: '/', screenshot: { waitForTOCScrolling: false } }],
+    //     tests: [
-    },
+    //         {
+    //             name: 'Home',
+    //             url: '/',
+    //             screenshot: { waitForTOCScrolling: false },
+    //             run: waitForCookiesDialog,
+    //         },
+    //     ],
+    // },
     {
         name: 'asiksupport-stg.dto.kemkes.go.id',
         contentBaseURL: 'https://asiksupport-stg.dto.kemkes.go.id',
@@ -33,7 +40,7 @@ const testCases: TestsCase[] = [
     {
         name: 'docs.dify.ai',
         contentBaseURL: 'https://docs.dify.ai',
-        tests: [{ name: 'Home', url: '/' }],
+        tests: [{ name: 'Home', url: '/', run: waitForCookiesDialog }],
     },
     {
         name: 'seeddao.gitbook.io',
@@ -63,32 +70,27 @@ const testCases: TestsCase[] = [
     {
         name: 'docs.portainer.io',
         contentBaseURL: 'https://docs.portainer.io',
-        tests: [{ name: 'Home', url: '/' }],
+        tests: [{ name: 'Home', url: '/', run: waitForCookiesDialog }],
     },
     {
         name: 'docs.chirptoken.io',
         contentBaseURL: 'https://docs.chirptoken.io',
-        tests: [{ name: 'Home', url: '/' }],
+        tests: [{ name: 'Home', url: '/', run: waitForCookiesDialog }],
     },
     {
         name: 'docs.dexscreener.com',
         contentBaseURL: 'https://docs.dexscreener.com',
-        tests: [{ name: 'Home', url: '/' }],
+        tests: [{ name: 'Home', url: '/', run: waitForCookiesDialog }],
     },
     {
         name: 'docs.pancakeswap.finance',
         contentBaseURL: 'https://docs.pancakeswap.finance',
-        tests: [{ name: 'Home', url: '/' }],
+        tests: [{ name: 'Home', url: '/', run: waitForCookiesDialog }],
     },
     {
         name: 'book.character.ai',
         contentBaseURL: 'https://book.character.ai',
-        tests: [{ name: 'Home', url: '/' }],
+        tests: [{ name: 'Home', url: '/', run: waitForCookiesDialog }],
-    },
-    {
-        name: 'docs.tradeonnova.io',
-        contentBaseURL: 'https://docs.tradeonnova.io',
-        tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'azcoiner.gitbook.io',
@@ -103,7 +105,7 @@ const testCases: TestsCase[] = [
     {
         name: 'docs.keeper.io',
         contentBaseURL: 'https://docs.keeper.io',
-        tests: [{ name: 'Home', url: '/' }],
+        tests: [{ name: 'Home', url: '/', run: waitForCookiesDialog }],
     },
     {
         name: 'adiblar.gitbook.io',
@@ -115,11 +117,11 @@ const testCases: TestsCase[] = [
         contentBaseURL: 'https://docs.gradient.network',
         tests: [{ name: 'Home', url: '/' }],
     },
-    {
+    // {
-        name: 'mygate-network.gitbook.io',
+    //     name: 'mygate-network.gitbook.io',
-        contentBaseURL: 'https://mygate-network.gitbook.io',
+    //     contentBaseURL: 'https://mygate-network.gitbook.io',
-        tests: [{ name: 'Home', url: '/' }],
+    //     tests: [{ name: 'Home', url: '/' }],
-    },
+    // },
     {
         name: 'treasurenft.gitbook.io',
         contentBaseURL: 'https://treasurenft.gitbook.io',
@@ -138,12 +140,12 @@ const testCases: TestsCase[] = [
     {
         name: 'meshnet.nordvpn.com',
         contentBaseURL: 'https://meshnet.nordvpn.com',
-        tests: [{ name: 'Home', url: '/' }],
+        tests: [{ name: 'Home', url: '/', run: waitForCookiesDialog }],
     },
     {
         name: 'manual.bubble.io',
         contentBaseURL: 'https://manual.bubble.io',
-        tests: [{ name: 'Home', url: '/' }],
+        tests: [{ name: 'Home', url: '/', run: waitForCookiesDialog }],
     },
     {
         name: 'docs.tickettool.xyz',
@@ -155,15 +157,15 @@ const testCases: TestsCase[] = [
         contentBaseURL: 'https://wiki.redmodding.org',
         tests: [{ name: 'Home', url: '/' }],
     },
-    {
+    // {
-        name: 'docs.cherry-ai.com',
+    //     name: 'docs.cherry-ai.com',
-        contentBaseURL: 'https://docs.cherry-ai.com',
+    //     contentBaseURL: 'https://docs.cherry-ai.com',
-        tests: [{ name: 'Home', url: '/' }],
+    //     tests: [{ name: 'Home', url: '/', run: waitForCookiesDialog }],
-    },
+    // },
     {
         name: 'docs.snyk.io',
         contentBaseURL: 'https://docs.snyk.io',
-        tests: [{ name: 'Home', url: '/' }],
+        tests: [{ name: 'Home', url: '/', run: waitForCookiesDialog }],
     },
     {
         name: 'docs.realapp.link',
@@ -188,22 +190,29 @@ const testCases: TestsCase[] = [
     {
         name: 'docs.umbraco.com',
         contentBaseURL: 'https://docs.umbraco.com',
-        tests: [{ name: 'Home', url: '/welcome', screenshot: { waitForTOCScrolling: false } }],
+        tests: [
+            {
+                name: 'Home',
+                url: '/welcome',
+                run: waitForCookiesDialog,
+                screenshot: { waitForTOCScrolling: false },
+            },
+        ],
     },
     {
         name: 'sosovalue-white-paper.gitbook.io',
         contentBaseURL: 'https://sosovalue-white-paper.gitbook.io',
         tests: [{ name: 'Home', url: '/' }],
     },
-    {
+    // {
-        name: 'docs.revrobotics.com',
+    //     name: 'docs.revrobotics.com',
-        contentBaseURL: 'https://docs.revrobotics.com',
+    //     contentBaseURL: 'https://docs.revrobotics.com',
-        tests: [{ name: 'Home', url: '/' }],
+    //     tests: [{ name: 'Home', url: '/', run: waitForCookiesDialog }],
-    },
+    // },
     {
         name: 'chartschool.stockcharts.com',
         contentBaseURL: 'https://chartschool.stockcharts.com',
-        tests: [{ name: 'Home', url: '/' }],
+        tests: [{ name: 'Home', url: '/', run: waitForCookiesDialog }],
     },
     {
         name: 'docs.soniclabs.com',
@@ -218,7 +227,7 @@ const testCases: TestsCase[] = [
     {
         name: 'docs.thousandeyes.com',
         contentBaseURL: 'https://docs.thousandeyes.com',
-        tests: [{ name: 'Home', url: '/' }],
+        tests: [{ name: 'Home', url: '/', run: waitForCookiesDialog }],
     },
     {
         name: 'docs.raydium.io',
@@ -228,7 +237,16 @@ const testCases: TestsCase[] = [
     {
         name: 'docs.fluentbit.io',
         contentBaseURL: 'https://docs.fluentbit.io',
-        tests: [{ name: 'Home', url: '/' }],
+        tests: [{ name: 'Home', url: '/', run: waitForCookiesDialog }],
+    },
+    {
+        name: 'run-ai-docs.nvidia.com',
+        contentBaseURL: 'https://run-ai-docs.nvidia.com',
+        skip: process.env.ARGOS_BUILD_NAME !== 'customers-v2',
+        tests: [
+            { name: 'Home', url: '/' },
+            { name: 'OG Image', url: '/~gitbook/ogimage/h17zQIFwy3MaafVNmItO', mode: 'image' },
+        ],
     },
 ];
 

packages/gitbook/e2e/internal.spec.ts

@@ -1,9 +1,12 @@
 import {
     CustomizationBackground,
     CustomizationCorners,
+    CustomizationDefaultMonospaceFont,
+    CustomizationDepth,
     CustomizationHeaderPreset,
     CustomizationIconsStyle,
     CustomizationSidebarListStyle,
+    CustomizationThemeMode,
 } from '@gitbook/api';
 import { expect } from '@playwright/test';
 import jwt from 'jsonwebtoken';
@@ -12,13 +15,14 @@ import {
     VISITOR_TOKEN_COOKIE,
     getVisitorAuthCookieName,
     getVisitorAuthCookieValue,
-} from '@/lib/visitor-token';
+} from '@/lib/visitors';
 
 import { getSiteAPIToken } from '../tests/utils';
 import {
     type TestsCase,
     allDeprecatedThemePresets,
     allLocales,
+    allSearchStyles,
     allSidebarBackgroundStyles,
     allThemeModes,
     allThemes,
@@ -27,6 +31,7 @@ import {
     headerLinks,
     runTestCases,
     waitForCookiesDialog,
+    waitForNotFound,
 } from './util';
 
 const testCases: TestsCase[] = [
@@ -109,24 +114,24 @@ const testCases: TestsCase[] = [
                 name: 'Customized variant titles are displayed',
                 url: '',
                 run: async (page) => {
-                    const spaceDrowpdown = page
+                    const spaceDropdown = page
                         .locator('[data-testid="space-dropdown-button"]')
                         .locator('visible=true');
-                    await spaceDrowpdown.click();
+                    await spaceDropdown.click();
 
                     const variantSelectionDropdown = page.locator(
-                        'css=[data-testid="space-dropdown-button"] + div'
+                        'css=[data-testid="dropdown-menu"]'
                     );
                     // the customized space title
                     await expect(
-                        variantSelectionDropdown.getByRole('link', {
+                        variantSelectionDropdown.getByRole('menuitem', {
                             name: 'Multi-Variants',
                         })
                     ).toBeVisible();
 
                     // the NON-customized space title
                     await expect(
-                        variantSelectionDropdown.getByRole('link', {
+                        variantSelectionDropdown.getByRole('menuitem', {
                             name: 'RFCs',
                         })
                     ).toBeVisible();
@@ -143,14 +148,17 @@ const testCases: TestsCase[] = [
                 url: 'api-multi-versions/reference/api-reference/pets',
                 screenshot: false,
                 run: async (page) => {
-                    const spaceDrowpdown = await page
+                    const spaceDropdown = await page
                         .locator('[data-testid="space-dropdown-button"]')
                         .locator('visible=true');
-                    await spaceDrowpdown.click();
+                    await spaceDropdown.click();
 
+                    const variantSelectionDropdown = page.locator(
+                        'css=[data-testid="dropdown-menu"]'
+                    );
                     // Click the second variant in the dropdown
-                    await page
+                    await variantSelectionDropdown
-                        .getByRole('link', {
+                        .getByRole('menuitem', {
                             name: '2.0',
                         })
                         .click();
@@ -166,14 +174,18 @@ const testCases: TestsCase[] = [
                 url: 'api-multi-versions-share-links/8tNo6MeXg7CkFMzSSz81/reference/api-reference/pets',
                 screenshot: false,
                 run: async (page) => {
-                    const spaceDrowpdown = await page
+                    const spaceDropdown = await page
                         .locator('[data-testid="space-dropdown-button"]')
                         .locator('visible=true');
-                    await spaceDrowpdown.click();
+                    await spaceDropdown.click();
+
+                    const variantSelectionDropdown = page.locator(
+                        'css=[data-testid="dropdown-menu"]'
+                    );
 
                     // Click the second variant in the dropdown
-                    await page
+                    await variantSelectionDropdown
-                        .getByRole('link', {
+                        .getByRole('menuitem', {
                             name: '2.0',
                         })
                         .click();
@@ -203,14 +215,18 @@ const testCases: TestsCase[] = [
                     return `api-multi-versions-va/reference/api-reference/pets?jwt_token=${token}`;
                 },
                 run: async (page) => {
-                    const spaceDrowpdown = await page
+                    const spaceDropdown = await page
                         .locator('[data-testid="space-dropdown-button"]')
                         .locator('visible=true');
-                    await spaceDrowpdown.click();
+                    await spaceDropdown.click();
+
+                    const variantSelectionDropdown = page.locator(
+                        'css=[data-testid="dropdown-menu"]'
+                    );
 
                     // Click the second variant in the dropdown
-                    await page
+                    await variantSelectionDropdown
-                        .getByRole('link', {
+                        .getByRole('menuitem', {
                             name: '2.0',
                         })
                         .click();
@@ -256,7 +272,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'GitBook',
-        contentBaseURL: 'https://docs.gitbook.com',
+        contentBaseURL: 'https://gitbook.com/docs/',
         tests: [
             {
                 name: 'Home',
@@ -307,6 +323,18 @@ const testCases: TestsCase[] = [
                 url: '~/revisions/S55pwsEr5UVoroaOiWnP/blocks/headings',
                 run: waitForCookiesDialog,
             },
+            {
+                name: 'Invalid revision',
+                url: '~/revisions/idnotfound/blocks/headings',
+                run: waitForNotFound,
+                screenshot: false,
+            },
+            {
+                name: 'Invalid change request',
+                url: '~/changes/idnotfound/blocks/headings',
+                run: waitForNotFound,
+                screenshot: false,
+            },
         ],
     },
     {
@@ -366,6 +394,130 @@ const testCases: TestsCase[] = [
             },
         ],
     },
+    {
+        name: 'Site Preview',
+        skip: process.env.ARGOS_BUILD_NAME !== 'v2-vercel',
+        tests: [
+            {
+                name: 'Main content',
+                url: async () => {
+                    const data = await getSiteAPIToken(
+                        'https://gitbook.gitbook.io/test-gitbook-open/'
+                    );
+
+                    const searchParams = new URLSearchParams();
+                    searchParams.set('token', data.apiToken);
+
+                    return `url/preview/${data.site}/?${searchParams.toString()}`;
+                },
+                screenshot: false,
+                run: async (page) => {
+                    await expect(page.locator('[data-testid="table-of-contents"]')).toBeVisible();
+                },
+            },
+        ],
+    },
+    {
+        name: 'Markdown page',
+        skip: process.env.ARGOS_BUILD_NAME !== 'v2-vercel',
+        contentBaseURL: 'https://gitbook.gitbook.io/test-gitbook-open/',
+        tests: [
+            {
+                name: 'Text page',
+                url: 'text-page.md',
+                screenshot: false,
+                run: async (_page, response) => {
+                    expect(response?.status()).toBe(200);
+                    expect(response?.headers()['content-type']).toContain('text/markdown');
+                },
+            },
+        ],
+    },
+    {
+        name: 'llms.txt',
+        skip: process.env.ARGOS_BUILD_NAME !== 'v2-vercel',
+        contentBaseURL: 'https://gitbook.gitbook.io/test-gitbook-open/',
+        tests: [
+            {
+                name: 'llms.txt',
+                url: 'llms.txt',
+                screenshot: false,
+                run: async (_page, response) => {
+                    expect(response?.status()).toBe(200);
+                    expect(response?.headers()['content-type']).toContain('text/markdown');
+                },
+            },
+        ],
+    },
+    {
+        name: 'llms-full.txt',
+        skip: process.env.ARGOS_BUILD_NAME !== 'v2-vercel',
+        contentBaseURL: 'https://gitbook.gitbook.io/test-gitbook-open/',
+        tests: [
+            {
+                name: 'llms-full.txt',
+                url: 'llms-full.txt',
+                screenshot: false,
+                run: async (_page, response) => {
+                    expect(response?.status()).toBe(200);
+                    expect(response?.headers()['content-type']).toContain('text/markdown');
+                },
+            },
+        ],
+    },
+    {
+        name: '[page].md',
+        skip: process.env.ARGOS_BUILD_NAME !== 'v2-vercel',
+        contentBaseURL: 'https://gitbook.gitbook.io/test-gitbook-open/',
+        tests: [
+            {
+                name: 'blocks.md',
+                url: 'blocks.md',
+                screenshot: false,
+                run: async (_page, response) => {
+                    expect(response?.status()).toBe(200);
+                    expect(response?.headers()['content-type']).toContain('text/markdown');
+                },
+            },
+        ],
+    },
+    {
+        name: 'Site subdirectory (proxy)',
+        skip: process.env.ARGOS_BUILD_NAME !== 'v2-vercel',
+        contentBaseURL: 'https://nextjs-gbo-proxy.vercel.app/documentation/',
+        tests: [
+            {
+                name: 'Main',
+                url: '',
+                fullPage: true,
+            },
+        ],
+    },
+    {
+        name: 'Site subdirectory (proxy) with VA',
+        skip: process.env.ARGOS_BUILD_NAME !== 'v2-vercel',
+        contentBaseURL: 'https://nextjs-gbo-proxy-va.vercel.app/va/docs/',
+        tests: [
+            {
+                name: 'Main',
+                url: () => {
+                    const privateKey =
+                        'rqSfA6x7eAKx1qDRCDq9aCXwivpUvQ8YkXeDdFvCCUa9QchIcM7pF1iJ4o7AGOU49spmOWjKoIPtX0pVUVQ81w==';
+                    const token = jwt.sign(
+                        {
+                            name: 'gitbook-open-tests',
+                        },
+                        privateKey,
+                        {
+                            expiresIn: '24h',
+                        }
+                    );
+                    return `?jwt_token=${token}`;
+                },
+                fullPage: true,
+            },
+        ],
+    },
     {
         name: 'Content tests',
         contentBaseURL: 'https://gitbook.gitbook.io/test-gitbook-open/',
@@ -385,7 +537,7 @@ const testCases: TestsCase[] = [
                 url: 'blocks/block-images',
                 run: waitForCookiesDialog,
                 fullPage: true,
-                screenshot: { threshold: 0.8 },
+                screenshot: { threshold: 0.9 },
             },
             {
                 name: 'Images (with zoom)',
@@ -396,7 +548,6 @@ const testCases: TestsCase[] = [
                     await zoomImage.first().click();
                     await expect(page.getByTestId('zoom-image-modal')).toBeVisible();
                 },
-                fullPage: true,
                 screenshot: { threshold: 0.8 },
             },
             {
@@ -431,7 +582,12 @@ const testCases: TestsCase[] = [
             {
                 name: 'Integration Blocks',
                 url: 'blocks/integrations',
-                run: waitForCookiesDialog,
+                run: async (page) => {
+                    await waitForCookiesDialog(page);
+                    const mermaidIframe = page.locator('iframe[title*="mermaid"]').contentFrame();
+                    await expect(mermaidIframe.getByText('Mermaid', { exact: true })).toBeVisible();
+                    await expect(mermaidIframe.getByText('Diagram', { exact: true })).toBeVisible();
+                },
             },
             {
                 name: 'Tables',
@@ -464,11 +620,21 @@ const testCases: TestsCase[] = [
                 url: 'blocks/emojis',
                 run: waitForCookiesDialog,
             },
+            {
+                name: 'Icons',
+                url: 'blocks/icons',
+                run: waitForCookiesDialog,
+            },
             {
                 name: 'Links',
                 url: 'blocks/links',
                 run: waitForCookiesDialog,
             },
+            {
+                name: 'Buttons',
+                url: 'blocks/buttons',
+                run: waitForCookiesDialog,
+            },
             {
                 name: 'Lists',
                 url: 'blocks/lists',
@@ -527,6 +693,7 @@ const testCases: TestsCase[] = [
                 name: 'Stepper',
                 url: 'blocks/stepper',
             },
+            { name: 'Columns', url: 'blocks/columns' },
         ],
     },
     {
@@ -543,6 +710,16 @@ const testCases: TestsCase[] = [
                 url: 'page-options/page-with-cover',
                 run: waitForCookiesDialog,
             },
+            {
+                name: 'With cover for dark mode',
+                url: `page-options/page-with-dark-cover${getCustomizationURL({
+                    themes: {
+                        default: CustomizationThemeMode.Dark,
+                        toggeable: false,
+                    },
+                })}`,
+                run: waitForCookiesDialog,
+            },
             {
                 name: 'With hero cover',
                 url: 'page-options/page-with-hero-cover',
@@ -622,6 +799,15 @@ const testCases: TestsCase[] = [
                 }),
                 run: waitForCookiesDialog,
             },
+            {
+                name: `With custom monospace font - Theme mode ${themeMode}`,
+                url: `blocks/code${getCustomizationURL({
+                    styling: {
+                        monospaceFont: CustomizationDefaultMonospaceFont.SpaceMono,
+                    },
+                })}`,
+                run: waitForCookiesDialog,
+            },
             // New site themes
             ...allThemes.flatMap((theme) => [
                 ...allTintColors.flatMap((tint) => [
@@ -647,6 +833,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) => [
@@ -695,6 +898,16 @@ const testCases: TestsCase[] = [
                 }),
                 run: waitForCookiesDialog,
             },
+            {
+                name: `With flat and circular corners - Theme mode ${themeMode}`,
+                url: getCustomizationURL({
+                    styling: {
+                        depth: CustomizationDepth.Flat,
+                        corners: CustomizationCorners.Circular,
+                    },
+                }),
+                run: waitForCookiesDialog,
+            },
         ]),
     },
     {
@@ -723,7 +936,7 @@ const testCases: TestsCase[] = [
                     ).toBeVisible();
                     const url = page.url();
                     expect(url.includes('shared-space-uno')).toBeTruthy(); // same uno site
-                    expect(url.endsWith('/shared')).toBeTruthy(); // correct page
+                    expect(url.endsWith('/shared/')).toBeTruthy(); // correct page
                 },
                 screenshot: false,
             },
@@ -743,7 +956,7 @@ const testCases: TestsCase[] = [
                     ).toBeVisible();
                     const url = page.url();
                     expect(url.includes('shared-space-dos')).toBeTruthy(); // same dos site
-                    expect(url.endsWith('/shared')).toBeTruthy(); // correct page
+                    expect(url.endsWith('/shared/')).toBeTruthy(); // correct page
                 },
                 screenshot: false,
             },
@@ -763,6 +976,35 @@ const testCases: TestsCase[] = [
             },
         ],
     },
+    {
+        name: 'Content Redirects',
+        contentBaseURL: 'https://gitbook-open-e2e-sites.gitbook.io/gitbook-doc/',
+        tests: [
+            {
+                name: 'Redirect to new location',
+                url: '/content-editor/editing-content/inline/redirect-test',
+                run: async (page) => {
+                    await expect(page.locator('h1')).toHaveText('Redirect test');
+                },
+                screenshot: false,
+            },
+        ],
+    },
+    {
+        name: 'Site Redirects with sections',
+        contentBaseURL: 'https://gitbook-open-e2e-sites.gitbook.io/sections/',
+        tests: [
+            {
+                // This test that a redirect that incudes a section path works
+                name: 'Redirect to Quickstart page',
+                url: 'sections-2/redirect-test',
+                run: async (page) => {
+                    await expect(page.locator('h1')).toHaveText('Quickstart');
+                },
+                screenshot: false,
+            },
+        ],
+    },
     {
         name: 'Share links',
         contentBaseURL: 'https://gitbook.gitbook.io/gbo-tests-share-links/',

packages/gitbook/e2e/pdf.spec.ts

@@ -0,0 +1,170 @@
+import { argosScreenshot } from '@argos-ci/playwright';
+import { expect, test } from '@playwright/test';
+import { getContentTestURL } from '../tests/utils';
+import { waitForIcons } from './util';
+
+test.describe('PDF export', () => {
+    test('export all pages as PDF (e2e)', async ({ page }) => {
+        // Set the header to disable the Vercel toolbar
+        // But only on the main document as it'd cause CORS issues on other resources
+        await page.route('**/*', async (route, request) => {
+            if (request.resourceType() === 'document') {
+                await route.continue({
+                    headers: {
+                        ...request.headers(),
+                        'x-vercel-skip-toolbar': '1',
+                    },
+                });
+            } else {
+                await route.continue();
+            }
+        });
+
+        await page.goto(
+            getContentTestURL(
+                'https://gitbook-open-e2e-sites.gitbook.io/gitbook-doc/~gitbook/pdf?limit=10'
+            )
+        );
+
+        const printBtn = page.getByTestId('print-button');
+        await expect(printBtn).toBeVisible();
+
+        await argosScreenshot(page, 'pdf - all pages', {
+            viewports: ['macbook-13'],
+            argosCSS: `
+                            /* Hide Intercom */
+                            .intercom-lightweight-app {
+                                display: none !important;
+                            }
+                            `,
+            threshold: undefined,
+            fullPage: true,
+            beforeScreenshot: async ({ runStabilization }) => {
+                await runStabilization();
+                await waitForIcons(page);
+            },
+        });
+    });
+
+    test('export all pages as PDF (GitBook docs)', async ({ page }) => {
+        // Set the header to disable the Vercel toolbar
+        // But only on the main document as it'd cause CORS issues on other resources
+        await page.route('**/*', async (route, request) => {
+            if (request.resourceType() === 'document') {
+                await route.continue({
+                    headers: {
+                        ...request.headers(),
+                        'x-vercel-skip-toolbar': '1',
+                    },
+                });
+            } else {
+                await route.continue();
+            }
+        });
+
+        await page.goto(getContentTestURL('https://gitbook.com/docs/~gitbook/pdf?limit=10'));
+
+        const printBtn = page.getByTestId('print-button');
+        await expect(printBtn).toBeVisible();
+
+        await argosScreenshot(page, 'pdf - all pages', {
+            viewports: ['macbook-13'],
+            argosCSS: `
+                            /* Hide Intercom */
+                            .intercom-lightweight-app {
+                                display: none !important;
+                            }
+                            `,
+            threshold: undefined,
+            fullPage: true,
+            beforeScreenshot: async ({ runStabilization }) => {
+                await runStabilization();
+                await waitForIcons(page);
+            },
+        });
+    });
+
+    test('export a single page as PDF (e2e)', async ({ page }) => {
+        // Set the header to disable the Vercel toolbar
+        // But only on the main document as it'd cause CORS issues on other resources
+        await page.route('**/*', async (route, request) => {
+            if (request.resourceType() === 'document') {
+                await route.continue({
+                    headers: {
+                        ...request.headers(),
+                        'x-vercel-skip-toolbar': '1',
+                    },
+                });
+            } else {
+                await route.continue();
+            }
+        });
+
+        await page.goto(
+            getContentTestURL(
+                'https://gitbook-open-e2e-sites.gitbook.io/gitbook-doc/~gitbook/pdf?page=Bw7LjWwgTjV8nIV4s7rs&only=yes&limit=2'
+            )
+        );
+
+        const printBtn = page.getByTestId('print-button');
+        await expect(printBtn).toBeVisible();
+
+        await argosScreenshot(page, 'pdf - all pages', {
+            viewports: ['macbook-13'],
+            argosCSS: `
+                            /* Hide Intercom */
+                            .intercom-lightweight-app {
+                                display: none !important;
+                            }
+                            `,
+            threshold: undefined,
+            fullPage: true,
+            beforeScreenshot: async ({ runStabilization }) => {
+                await runStabilization();
+                await waitForIcons(page);
+            },
+        });
+    });
+
+    test('export a single page as PDF (GitBook docs)', async ({ page }) => {
+        // Set the header to disable the Vercel toolbar
+        // But only on the main document as it'd cause CORS issues on other resources
+        await page.route('**/*', async (route, request) => {
+            if (request.resourceType() === 'document') {
+                await route.continue({
+                    headers: {
+                        ...request.headers(),
+                        'x-vercel-skip-toolbar': '1',
+                    },
+                });
+            } else {
+                await route.continue();
+            }
+        });
+
+        await page.goto(
+            getContentTestURL(
+                'https://gitbook.com/docs/~gitbook/pdf?page=DfnNkU49mvLe2ythHAyx&only=yes&limit=2'
+            )
+        );
+
+        const printBtn = page.getByTestId('print-button');
+        await expect(printBtn).toBeVisible();
+
+        await argosScreenshot(page, 'pdf - all pages', {
+            viewports: ['macbook-13'],
+            argosCSS: `
+                            /* Hide Intercom */
+                            .intercom-lightweight-app {
+                                display: none !important;
+                            }
+                            `,
+            threshold: undefined,
+            fullPage: true,
+            beforeScreenshot: async ({ runStabilization }) => {
+                await runStabilization();
+                await waitForIcons(page);
+            },
+        });
+    });
+});

packages/gitbook/e2e/util.ts

@@ -1,21 +1,26 @@
 import { argosScreenshot } from '@argos-ci/playwright';
 import {
+    CustomizationAIMode,
     CustomizationBackground,
     CustomizationCorners,
-    CustomizationFont,
+    CustomizationDefaultFont,
+    CustomizationDefaultMonospaceFont,
+    CustomizationDepth,
     type CustomizationHeaderItem,
     CustomizationHeaderPreset,
     CustomizationIconsStyle,
     CustomizationLinksStyle,
     CustomizationLocale,
+    CustomizationSearchStyle,
     CustomizationSidebarBackgroundStyle,
     CustomizationSidebarListStyle,
     CustomizationTheme,
     CustomizationThemeMode,
     type CustomizationThemedColor,
     type SiteCustomizationSettings,
+    SiteExternalLinksTarget,
 } from '@gitbook/api';
-import { type BrowserContext, type Page, expect, test } from '@playwright/test';
+import { type BrowserContext, type Page, type Response, expect, test } from '@playwright/test';
 import deepMerge from 'deepmerge';
 import rison from 'rison';
 import type { DeepPartial } from 'ts-essentials';
@@ -32,7 +37,11 @@ export interface Test {
     /**
      * Test to run
      */
-    run?: (page: Page) => Promise<unknown>;
+    run?: (page: Page, response: Response | null) => Promise<unknown>;
+    /**
+     * Mode for the test.
+     */
+    mode?: 'page' | 'image';
     /**
      * Whether the test should be fullscreened during testing.
      */
@@ -62,6 +71,7 @@ export interface Test {
 
 export type TestsCase = {
     name: string;
+    skip?: boolean;
     tests: Array<Test>;
     contentBaseURL?: string;
 };
@@ -109,6 +119,11 @@ export const allSidebarBackgroundStyles: CustomizationSidebarBackgroundStyle[] =
     CustomizationSidebarBackgroundStyle.Filled,
 ];
 
+export const allSearchStyles: CustomizationSearchStyle[] = [
+    CustomizationSearchStyle.Prominent,
+    CustomizationSearchStyle.Subtle,
+];
+
 // Common customization settings
 
 export const headerLinks: CustomizationHeaderItem[] = [
@@ -127,11 +142,13 @@ export const headerLinks: CustomizationHeaderItem[] = [
 ];
 
 export async function waitForCookiesDialog(page: Page) {
-    const dialog = page.getByRole('dialog', { name: 'Cookies' });
+    const dialog = page.getByTestId('cookies-dialog');
-    const accept = dialog.getByRole('button', { name: 'Accept' });
+    await expect(dialog).toBeVisible();
-    const reject = dialog.getByRole('button', { name: 'Reject' });
+}
-    await expect(accept).toBeVisible();
+
-    await expect(reject).toBeVisible();
+export async function waitForNotFound(_page: Page, response: Response | null) {
+    expect(response).not.toBeNull();
+    expect(response?.status()).toBe(404);
 }
 
 /**
@@ -139,8 +156,13 @@ export async function waitForCookiesDialog(page: Page) {
  */
 export function runTestCases(testCases: TestsCase[]) {
     for (const testCase of testCases) {
+        if (testCase.skip) {
+            continue;
+        }
+
         test.describe(testCase.name, () => {
             for (const testEntry of testCase.tests) {
+                const { mode = 'page' } = testEntry;
                 const testFn = testEntry.only ? test.only : test;
                 testFn(testEntry.name, async ({ page, context }) => {
                     const testEntryPathname =
@@ -150,6 +172,7 @@ export function runTestCases(testCases: TestsCase[]) {
                               new URL(testEntryPathname, testCase.contentBaseURL).toString()
                           )
                         : getTestURL(testEntryPathname);
+
                     if (testEntry.cookies) {
                         await context.addCookies(
                             testEntry.cookies.map((cookie) => ({
@@ -175,13 +198,21 @@ export function runTestCases(testCases: TestsCase[]) {
                         }
                     });
 
-                    await page.goto(url);
+                    const response = await page.goto(url);
                     if (testEntry.run) {
-                        await testEntry.run(page);
+                        await testEntry.run(page, response);
                     }
                     const screenshotOptions = testEntry.screenshot;
                     if (screenshotOptions !== false) {
-                        await argosScreenshot(page, `${testCase.name} - ${testEntry.name}`, {
+                        const screenshotName = `${testCase.name} - ${testEntry.name}`;
+                        if (mode === 'image') {
+                            await argosScreenshot(page, screenshotName, {
+                                viewports: ['macbook-13'],
+                                threshold: screenshotOptions?.threshold ?? undefined,
+                                fullPage: true,
+                            });
+                        } else {
+                            await argosScreenshot(page, screenshotName, {
                                 viewports: ['macbook-16', 'macbook-13', 'ipad-2', 'iphone-x'],
                                 argosCSS: `
                             /* Hide Intercom */
@@ -191,14 +222,16 @@ export function runTestCases(testCases: TestsCase[]) {
                             `,
                                 threshold: screenshotOptions?.threshold ?? undefined,
                                 fullPage: testEntry.fullPage ?? false,
-                            beforeScreenshot: async () => {
+                                beforeScreenshot: async ({ runStabilization }) => {
-                                await waitForIcons(page);
+                                    await runStabilization();
                                     if (screenshotOptions?.waitForTOCScrolling !== false) {
                                         await waitForTOCScrolling(page);
                                     }
+                                    await waitForIcons(page);
                                 },
                             });
                         }
+                    }
                 });
             }
         });
@@ -249,7 +282,9 @@ export function getCustomizationURL(partial: DeepPartial<SiteCustomizationSettin
             dangerColor: { light: '#FB2C36', dark: '#FB2C36' },
             successColor: { light: '#00C950', dark: '#00C950' },
             corners: CustomizationCorners.Rounded,
-            font: CustomizationFont.Inter,
+            depth: CustomizationDepth.Subtle,
+            font: CustomizationDefaultFont.Inter,
+            monospaceFont: CustomizationDefaultMonospaceFont.IBMPlexMono,
             background: CustomizationBackground.Plain,
             icons: CustomizationIconsStyle.Regular,
             links: CustomizationLinksStyle.Default,
@@ -257,10 +292,14 @@ export function getCustomizationURL(partial: DeepPartial<SiteCustomizationSettin
                 background: CustomizationSidebarBackgroundStyle.Default,
                 list: CustomizationSidebarListStyle.Default,
             },
+            search: CustomizationSearchStyle.Subtle,
         },
         internationalization: {
             locale: CustomizationLocale.En,
         },
+        insights: {
+            trackingCookie: true,
+        },
         favicon: {},
         header: {
             preset: CustomizationHeaderPreset.Default,
@@ -279,9 +318,16 @@ export function getCustomizationURL(partial: DeepPartial<SiteCustomizationSettin
         feedback: {
             enabled: false,
         },
+        // TODO: remove aiSearch once the cache has been fully updated (after 11/07/2025)
         aiSearch: {
             enabled: true,
         },
+        ai: {
+            mode: CustomizationAIMode.None,
+        },
+        externalLinks: {
+            target: SiteExternalLinksTarget.Self,
+        },
         advancedCustomization: {
             enabled: true,
         },
@@ -311,30 +357,84 @@ export function getCustomizationURL(partial: DeepPartial<SiteCustomizationSettin
 /**
  * Wait for all icons present on the page to be loaded.
  */
-async function waitForIcons(page: Page) {
+export async function waitForIcons(page: Page) {
-    await page.waitForFunction(async () => {
+    await page.waitForFunction(() => {
-        function loadImage(src: string) {
+        const urlStates: Record<
-            return new Promise((resolve, reject) => {
+            string,
-                const img = new Image();
+            { state: 'pending'; uri: null } | { state: 'loaded'; uri: string }
-                img.onload = () => resolve(img);
+        > = (window as any).__ICONS_STATES__ || {};
-                img.onerror = (_error) => reject(new Error(`Failed to load image: ${src}`));
+        (window as any).__ICONS_STATES__ = urlStates;
-                img.src = src;
+
-            });
+        const fetchSvgAsDataUri = async (url: string): Promise<string> => {
+            const response = await fetch(url);
+            if (!response.ok) {
+                throw new Error(`Failed to fetch SVG: ${response.status}`);
             }
 
+            const svgText = await response.text();
+            const encoded = encodeURIComponent(svgText).replace(/'/g, '%27').replace(/"/g, '%22');
+
+            return `data:image/svg+xml;charset=utf-8,${encoded}`;
+        };
+
+        const loadUrl = (url: string) => {
+            // Mark the URL as pending.
+            urlStates[url] = { state: 'pending', uri: null };
+            fetchSvgAsDataUri(url).then((uri) => {
+                urlStates[url] = { state: 'loaded', uri };
+            });
+        };
+
         const icons = Array.from(document.querySelectorAll('svg.gb-icon'));
-        await Promise.all(
+        const results = icons.map((icon) => {
-            icons.map(async (icon) => {
+            if (!(icon instanceof SVGElement)) {
+                throw new Error('Icon is not an SVGElement');
+            }
+
+            // Ignore icons that are not visible.
+            if (!icon.checkVisibility()) {
+                return true;
+            }
+
+            const state = icon.getAttribute('data-argos-state');
+
+            if (state === 'pending') {
+                return false;
+            }
+
+            if (state === 'loaded') {
+                return true;
+            }
+
             // url("https://ka-p.fontawesome.com/releases/v6.6.0/svgs/light/moon.svg?v=2&token=a463935e93")
             const maskImage = window.getComputedStyle(icon).getPropertyValue('mask-image');
             const urlMatch = maskImage.match(/url\("([^"]+)"\)/);
-                const url = urlMatch ? urlMatch[1] : null;
+            const url = urlMatch?.[1];
+
+            // If URL is invalid we throw an error.
             if (!url) {
                 throw new Error('No mask-image');
             }
-                await loadImage(url);
+
-            })
+            // If the URL is already queued for loading, we return the state.
-        );
+            if (urlStates[url]) {
+                if (urlStates[url].state === 'loaded') {
+                    icon.setAttribute('data-argos-state', 'pending');
+                    icon.style.maskImage = `url("${urlStates[url].uri}")`;
+                    requestAnimationFrame(() => {
+                        icon.setAttribute('data-argos-state', 'loaded');
+                    });
+                    return false;
+                }
+
+                return false;
+            }
+
+            loadUrl(url);
+            return false;
+        });
+
+        return results.every((x) => x);
     });
 }
 

packages/gitbook/next.config.js

@@ -1,83 +0,0 @@
-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',
-                },
-            ],
-        },
-    },
-    {
-        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,
-    }
-);

packages/gitbook/next.config.mjs

@@ -5,7 +5,15 @@
  */
 const nextConfig = {
     experimental: {
+        // This is needed to throw "forbidden" when the api token expired during revalidation
+        authInterrupts: true,
         useCache: true,
+
+        // Content is fully static, we can cache it in the session memory cache for a long time
+        staleTimes: {
+            dynamic: 3600, // 1 hour
+            static: 3600, // 1 hour
+        },
     },
 
     env: {
@@ -23,6 +31,9 @@ const nextConfig = {
         GITBOOK_ASSETS_PREFIX: process.env.GITBOOK_ASSETS_PREFIX,
         GITBOOK_SECRET: process.env.GITBOOK_SECRET,
         GITBOOK_IMAGE_RESIZE_SIGNING_KEY: process.env.GITBOOK_IMAGE_RESIZE_SIGNING_KEY,
+        GITBOOK_IMAGE_RESIZE_MODE: process.env.GITBOOK_IMAGE_RESIZE_MODE,
+        GITBOOK_FONTS_URL: process.env.GITBOOK_FONTS_URL,
+        GITBOOK_RUNTIME: process.env.GITBOOK_RUNTIME,
 
         // Next.js envs
         NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: process.env.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY,
@@ -42,6 +53,24 @@ const nextConfig = {
             },
         ],
     },
+
+    async headers() {
+        return [
+            {
+                source: '/~gitbook/static/:path*',
+                headers: [
+                    {
+                        key: 'Cache-Control',
+                        value: 'public, max-age=31536000, immutable',
+                    },
+                    {
+                        key: 'Access-Control-Allow-Origin',
+                        value: '*',
+                    },
+                ],
+            },
+        ];
+    },
 };
 
 export default nextConfig;

packages/gitbook/open-next.config.ts

@@ -0,0 +1,29 @@
+import type { OpenNextConfig } from '@opennextjs/cloudflare';
+
+export default {
+    default: {
+        override: {
+            wrapper: 'cloudflare-node',
+            converter: 'edge',
+            proxyExternalRequest: 'fetch',
+            queue: () => import('./openNext/queue/middleware').then((m) => m.default),
+            incrementalCache: () => import('./openNext/incrementalCache').then((m) => m.default),
+            tagCache: () => import('./openNext/tagCache/middleware').then((m) => m.default),
+        },
+    },
+    middleware: {
+        external: true,
+        override: {
+            wrapper: 'cloudflare-edge',
+            converter: 'edge',
+            proxyExternalRequest: 'fetch',
+            queue: () => import('./openNext/queue/middleware').then((m) => m.default),
+            incrementalCache: () => import('./openNext/incrementalCache').then((m) => m.default),
+            tagCache: () => import('./openNext/tagCache/middleware').then((m) => m.default),
+        },
+    },
+    dangerous: {
+        enableCacheInterception: true,
+    },
+    edgeExternals: ['node:crypto'],
+} satisfies OpenNextConfig;

packages/gitbook/openNext/customWorkers/default.js

@@ -0,0 +1,36 @@
+import { runWithCloudflareRequestContext } from '../../.open-next/cloudflare/init.js';
+
+import { DurableObject } from 'cloudflare:workers';
+
+// Only needed to run locally, in prod we'll use the one from do.js
+export class R2WriteBuffer extends DurableObject {
+    writePromise;
+
+    async write(cacheKey, value) {
+        // We are already writing to this key
+        if (this.writePromise) {
+            return;
+        }
+
+        this.writePromise = this.env.NEXT_INC_CACHE_R2_BUCKET.put(cacheKey, value);
+        this.ctx.waitUntil(
+            this.writePromise.finally(() => {
+                this.writePromise = undefined;
+            })
+        );
+    }
+}
+
+export default {
+    async fetch(request, env, ctx) {
+        return runWithCloudflareRequestContext(request, env, ctx, async () => {
+            // We can't move the handler import to the top level, otherwise the runtime will not be properly initialized
+            const { handler } = await import(
+                '../../.open-next/server-functions/default/handler.mjs'
+            );
+
+            // - `Request`s are handled by the Next server
+            return handler(request, env, ctx);
+        });
+    },
+};

packages/gitbook/openNext/customWorkers/defaultWrangler.jsonc

@@ -0,0 +1,168 @@
+{
+    "main": "default.js",
+    "name": "gitbook-open-v2-server",
+    "compatibility_date": "2025-04-14",
+    "compatibility_flags": [
+        "nodejs_compat",
+        "allow_importable_env",
+        "global_fetch_strictly_public"
+    ],
+    "observability": {
+        "enabled": true
+    },
+    "vars": {
+        "NEXT_CACHE_DO_QUEUE_DISABLE_SQLITE": "true"
+    },
+    "env": {
+        "dev": {
+            "vars": {
+                "STAGE": "dev"
+            },
+            "r2_buckets": [
+                {
+                    "binding": "NEXT_INC_CACHE_R2_BUCKET",
+                    "bucket_name": "gitbook-open-v2-cache-preview"
+                }
+            ],
+            "services": [
+                {
+                    "binding": "WORKER_SELF_REFERENCE",
+                    "service": "gitbook-open-v2-server-dev"
+                }
+            ],
+            "durable_objects": {
+                "bindings": [
+                    {
+                        "name": "WRITE_BUFFER",
+                        "class_name": "R2WriteBuffer"
+                    }
+                ]
+            },
+            "migrations": [
+                {
+                    "tag": "v1",
+                    "new_sqlite_classes": ["R2WriteBuffer"]
+                }
+            ]
+        },
+        "preview": {
+            "vars": {
+                "STAGE": "preview",
+                // Just as a test for the preview environment to check that everything works
+                "NEXT_PRIVATE_DEBUG_CACHE": "true"
+            },
+            "r2_buckets": [
+                {
+                    "binding": "NEXT_INC_CACHE_R2_BUCKET",
+                    "bucket_name": "gitbook-open-v2-cache-preview"
+                }
+            ],
+            "services": [
+                {
+                    "binding": "WORKER_SELF_REFERENCE",
+                    "service": "gitbook-open-v2-server-preview"
+                }
+            ],
+            "durable_objects": {
+                "bindings": [
+                    {
+                        "name": "WRITE_BUFFER",
+                        "class_name": "R2WriteBuffer",
+                        "script_name": "gitbook-open-v2-do-preview"
+                    },
+                    {
+                        "name": "NEXT_TAG_CACHE_DO_SHARDED",
+                        "class_name": "DOShardedTagCache",
+                        "script_name": "gitbook-open-v2-do-preview"
+                    },
+                    {
+                        "name": "NEXT_CACHE_DO_QUEUE",
+                        "class_name": "DOQueueHandler",
+                        "script_name": "gitbook-open-v2-do-preview"
+                    }
+                ]
+            }
+        },
+        "staging": {
+            "r2_buckets": [
+                {
+                    "binding": "NEXT_INC_CACHE_R2_BUCKET",
+                    "bucket_name": "gitbook-open-v2-cache-staging"
+                }
+            ],
+            "services": [
+                {
+                    "binding": "WORKER_SELF_REFERENCE",
+                    "service": "gitbook-open-v2-server-staging"
+                }
+            ],
+            "durable_objects": {
+                "bindings": [
+                    {
+                        "name": "WRITE_BUFFER",
+                        "class_name": "R2WriteBuffer",
+                        "script_name": "gitbook-open-v2-do-staging"
+                    },
+                    {
+                        "name": "NEXT_TAG_CACHE_DO_SHARDED",
+                        "class_name": "DOShardedTagCache",
+                        "script_name": "gitbook-open-v2-do-staging"
+                    },
+                    {
+                        "name": "NEXT_CACHE_DO_QUEUE",
+                        "class_name": "DOQueueHandler",
+                        "script_name": "gitbook-open-v2-do-staging"
+                    }
+                ]
+            },
+            "tail_consumers": [
+                {
+                    "service": "gitbook-x-staging-tail"
+                }
+            ]
+        },
+        "production": {
+            "vars": {
+                // This is a bit misleading, but it means that we can have 500 concurrent revalidations
+                // This means that we'll have up to 100 durable objects instance running at the same time
+                "MAX_REVALIDATE_CONCURRENCY": "100"
+            },
+            "r2_buckets": [
+                {
+                    "binding": "NEXT_INC_CACHE_R2_BUCKET",
+                    "bucket_name": "gitbook-open-v2-cache-production"
+                }
+            ],
+            "services": [
+                {
+                    "binding": "WORKER_SELF_REFERENCE",
+                    "service": "gitbook-open-v2-server-production"
+                }
+            ],
+            "durable_objects": {
+                "bindings": [
+                    {
+                        "name": "WRITE_BUFFER",
+                        "class_name": "R2WriteBuffer",
+                        "script_name": "gitbook-open-v2-do-production"
+                    },
+                    {
+                        "name": "NEXT_TAG_CACHE_DO_SHARDED",
+                        "class_name": "DOShardedTagCache",
+                        "script_name": "gitbook-open-v2-do-production"
+                    },
+                    {
+                        "name": "NEXT_CACHE_DO_QUEUE",
+                        "class_name": "DOQueueHandler",
+                        "script_name": "gitbook-open-v2-do-production"
+                    }
+                ]
+            },
+            "tail_consumers": [
+                {
+                    "service": "gitbook-x-prod-tail"
+                }
+            ]
+        }
+    }
+}

packages/gitbook/openNext/customWorkers/do.js

@@ -0,0 +1,38 @@
+// This worker only purposes it to host the different DO that we will need in the other workers.
+import { DurableObject } from 'cloudflare:workers';
+
+// `use cache` could cause multiple writes to the same key to happen concurrently, there is a limit of 1 write per key/second
+// so we need to buffer writes to the R2 bucket to avoid hitting this limit.
+export class R2WriteBuffer extends DurableObject {
+    writePromise;
+
+    async write(cacheKey, value) {
+        // We are already writing to this key
+        if (this.writePromise) {
+            return;
+        }
+
+        this.writePromise = this.env.NEXT_INC_CACHE_R2_BUCKET.put(cacheKey, value);
+        this.ctx.waitUntil(
+            this.writePromise.finally(() => {
+                this.writePromise = undefined;
+            })
+        );
+    }
+}
+
+export { DOQueueHandler } from '../../.open-next/.build/durable-objects/queue.js';
+
+export { DOShardedTagCache } from '../../.open-next/.build/durable-objects/sharded-tag-cache.js';
+
+export default {
+    async fetch() {
+        // This worker does not handle any requests, it only provides Durable Objects
+        return new Response('This worker is not meant to handle requests directly', {
+            status: 400,
+            headers: {
+                'Content-Type': 'text/plain',
+            },
+        });
+    },
+};

packages/gitbook/openNext/customWorkers/doWrangler.jsonc

@@ -0,0 +1,149 @@
+{
+    "main": "do.js",
+    "name": "gitbook-open-v2-do",
+    "compatibility_date": "2025-04-14",
+    "compatibility_flags": [
+        "nodejs_compat",
+        "allow_importable_env",
+        "global_fetch_strictly_public"
+    ],
+    "observability": {
+        "enabled": true
+    },
+    "env": {
+        "preview": {
+            "vars": {
+                "STAGE": "preview",
+                "NEXT_CACHE_DO_QUEUE_DISABLE_SQLITE": "true"
+            },
+            "r2_buckets": [
+                {
+                    "binding": "NEXT_INC_CACHE_R2_BUCKET",
+                    "bucket_name": "gitbook-open-v2-cache-preview"
+                }
+            ],
+            "services": [
+                {
+                    "binding": "WORKER_SELF_REFERENCE",
+                    "service": "gitbook-open-v2-preview"
+                }
+            ],
+            "durable_objects": {
+                "bindings": [
+                    {
+                        "name": "NEXT_CACHE_DO_QUEUE",
+                        "class_name": "DOQueueHandler"
+                    },
+                    {
+                        "name": "NEXT_TAG_CACHE_DO_SHARDED",
+                        "class_name": "DOShardedTagCache"
+                    },
+                    {
+                        "name": "WRITE_BUFFER",
+                        "class_name": "R2WriteBuffer"
+                    }
+                ]
+            },
+            "migrations": [
+                {
+                    "tag": "v1",
+                    "new_sqlite_classes": ["DOQueueHandler", "DOShardedTagCache", "R2WriteBuffer"]
+                }
+            ]
+        },
+        "staging": {
+            "vars": {
+                "STAGE": "staging",
+                "NEXT_CACHE_DO_QUEUE_DISABLE_SQLITE": "true"
+            },
+            "r2_buckets": [
+                {
+                    "binding": "NEXT_INC_CACHE_R2_BUCKET",
+                    "bucket_name": "gitbook-open-v2-cache-staging"
+                }
+            ],
+            "tail_consumers": [
+                {
+                    "service": "gitbook-x-staging-tail"
+                }
+            ],
+            "services": [
+                {
+                    "binding": "WORKER_SELF_REFERENCE",
+                    "service": "gitbook-open-v2-staging"
+                }
+            ],
+            "durable_objects": {
+                "bindings": [
+                    {
+                        "name": "NEXT_CACHE_DO_QUEUE",
+                        "class_name": "DOQueueHandler"
+                    },
+                    {
+                        "name": "NEXT_TAG_CACHE_DO_SHARDED",
+                        "class_name": "DOShardedTagCache"
+                    },
+                    {
+                        "name": "WRITE_BUFFER",
+                        "class_name": "R2WriteBuffer"
+                    }
+                ]
+            },
+            "migrations": [
+                {
+                    "tag": "v1",
+                    "new_sqlite_classes": ["DOQueueHandler", "DOShardedTagCache", "R2WriteBuffer"]
+                }
+            ]
+        },
+        "production": {
+            "vars": {
+                // R2 is strongly consistent, so we can disable SQLite
+                "NEXT_CACHE_DO_QUEUE_DISABLE_SQLITE": "true",
+                // We don't want to pollute the memory with broken cache entries
+                // Most of the time, those are fake requests.
+                "NEXT_CACHE_DO_QUEUE_MAX_RETRIES": "1",
+                "STAGE": "production"
+            },
+            "r2_buckets": [
+                {
+                    "binding": "NEXT_INC_CACHE_R2_BUCKET",
+                    "bucket_name": "gitbook-open-v2-cache-production"
+                }
+            ],
+            "tail_consumers": [
+                {
+                    "service": "gitbook-x-prod-tail"
+                }
+            ],
+            "services": [
+                {
+                    "binding": "WORKER_SELF_REFERENCE",
+                    "service": "gitbook-open-v2-production"
+                }
+            ],
+            "durable_objects": {
+                "bindings": [
+                    {
+                        "name": "NEXT_CACHE_DO_QUEUE",
+                        "class_name": "DOQueueHandler"
+                    },
+                    {
+                        "name": "NEXT_TAG_CACHE_DO_SHARDED",
+                        "class_name": "DOShardedTagCache"
+                    },
+                    {
+                        "name": "WRITE_BUFFER",
+                        "class_name": "R2WriteBuffer"
+                    }
+                ]
+            },
+            "migrations": [
+                {
+                    "tag": "v1",
+                    "new_sqlite_classes": ["DOQueueHandler", "DOShardedTagCache", "R2WriteBuffer"]
+                }
+            ]
+        }
+    }
+}

packages/gitbook/openNext/customWorkers/middleware.js

@@ -0,0 +1,42 @@
+import { WorkerEntrypoint } from 'cloudflare:workers';
+import { runWithCloudflareRequestContext } from '../../.open-next/cloudflare/init.js';
+
+import { handler as middlewareHandler } from '../../.open-next/middleware/handler.mjs';
+
+export { DOQueueHandler } from '../../.open-next/.build/durable-objects/queue.js';
+
+export { DOShardedTagCache } from '../../.open-next/.build/durable-objects/sharded-tag-cache.js';
+
+export default class extends WorkerEntrypoint {
+    async fetch(request) {
+        return runWithCloudflareRequestContext(request, this.env, this.ctx, async () => {
+            // - `Request`s are handled by the Next server
+            const reqOrResp = await middlewareHandler(request, this.env, this.ctx);
+            if (reqOrResp instanceof Response) {
+                return reqOrResp;
+            }
+
+            if (this.env.STAGE !== 'preview') {
+                // https://developers.cloudflare.com/workers/configuration/versions-and-deployments/gradual-deployments/#version-affinity
+                reqOrResp.headers.set(
+                    'Cloudflare-Workers-Version-Overrides',
+                    `gitbook-open-v2-${this.env.STAGE}="${this.env.WORKER_VERSION_ID}"`
+                );
+                return this.env.DEFAULT_WORKER?.fetch(reqOrResp, {
+                    cf: {
+                        cacheEverything: false,
+                    },
+                });
+            }
+            // If we are in preview mode, we need to send the request to the preview URL
+            const modifiedUrl = new URL(reqOrResp.url);
+            modifiedUrl.hostname = this.env.PREVIEW_HOSTNAME;
+            const nextRequest = new Request(modifiedUrl, reqOrResp);
+            return fetch(nextRequest, {
+                cf: {
+                    cacheEverything: false,
+                },
+            });
+        });
+    }
+}

packages/gitbook/openNext/customWorkers/middlewareWrangler.jsonc

@@ -0,0 +1,216 @@
+{
+    "main": "middleware.js",
+    "name": "gitbook-open-v2",
+    "compatibility_date": "2025-04-14",
+    "compatibility_flags": [
+        "nodejs_compat",
+        "allow_importable_env",
+        "global_fetch_strictly_public"
+    ],
+    "assets": {
+        "directory": "../../.open-next/assets",
+        "binding": "ASSETS"
+    },
+    "observability": {
+        "enabled": true
+    },
+    "vars": {
+        "NEXT_CACHE_DO_QUEUE_DISABLE_SQLITE": "true"
+    },
+    "env": {
+        "dev": {
+            "vars": {
+                "STAGE": "dev",
+                "NEXT_PRIVATE_DEBUG_CACHE": "true"
+            },
+            "r2_buckets": [
+                {
+                    "binding": "NEXT_INC_CACHE_R2_BUCKET",
+                    "bucket_name": "gitbook-open-v2-cache-preview"
+                }
+            ],
+            "services": [
+                {
+                    "binding": "WORKER_SELF_REFERENCE",
+                    "service": "gitbook-open-v2-dev"
+                },
+                {
+                    "binding": "DEFAULT_WORKER",
+                    "service": "gitbook-open-v2-server-dev"
+                }
+            ]
+        },
+        "preview": {
+            "vars": {
+                "STAGE": "preview",
+                "PREVIEW_HOSTNAME": "TO_REPLACE",
+                "WORKER_VERSION_ID": "TO_REPLACE"
+            },
+            "r2_buckets": [
+                {
+                    "binding": "NEXT_INC_CACHE_R2_BUCKET",
+                    "bucket_name": "gitbook-open-v2-cache-preview"
+                }
+            ],
+            "services": [
+                {
+                    "binding": "WORKER_SELF_REFERENCE",
+                    "service": "gitbook-open-v2-preview"
+                },
+                {
+                    "binding": "DEFAULT_WORKER",
+                    "service": "gitbook-open-v2-server-preview"
+                }
+            ],
+            "durable_objects": {
+                "bindings": [
+                    {
+                        "name": "WRITE_BUFFER",
+                        "class_name": "R2WriteBuffer",
+                        "script_name": "gitbook-open-v2-do-preview"
+                    },
+                    {
+                        "name": "NEXT_TAG_CACHE_DO_SHARDED",
+                        "class_name": "DOShardedTagCache",
+                        "script_name": "gitbook-open-v2-do-preview"
+                    },
+                    {
+                        "name": "NEXT_CACHE_DO_QUEUE",
+                        "class_name": "DOQueueHandler",
+                        "script_name": "gitbook-open-v2-do-preview"
+                    }
+                ]
+            }
+        },
+        "staging": {
+            "vars": {
+                "STAGE": "staging",
+                "WORKER_VERSION_ID": "TO_REPLACE"
+            },
+            "routes": [
+                {
+                    "pattern": "open-2c.gitbook-staging.com/*",
+                    "zone_name": "gitbook-staging.com"
+                },
+                {
+                    "pattern": "static-2c.gitbook-staging.com/*",
+                    "zone_name": "gitbook-staging.com"
+                }
+            ],
+            "r2_buckets": [
+                {
+                    "binding": "NEXT_INC_CACHE_R2_BUCKET",
+                    "bucket_name": "gitbook-open-v2-cache-staging"
+                }
+            ],
+            "services": [
+                {
+                    "binding": "WORKER_SELF_REFERENCE",
+                    "service": "gitbook-open-v2-staging"
+                },
+                {
+                    "binding": "DEFAULT_WORKER",
+                    "service": "gitbook-open-v2-server-staging"
+                }
+            ],
+            "tail_consumers": [
+                {
+                    "service": "gitbook-x-staging-tail"
+                }
+            ],
+            "durable_objects": {
+                "bindings": [
+                    {
+                        "name": "WRITE_BUFFER",
+                        "class_name": "R2WriteBuffer",
+                        "script_name": "gitbook-open-v2-do-staging"
+                    },
+                    {
+                        "name": "NEXT_TAG_CACHE_DO_SHARDED",
+                        "class_name": "DOShardedTagCache",
+                        "script_name": "gitbook-open-v2-do-staging"
+                    },
+                    {
+                        "name": "NEXT_CACHE_DO_QUEUE",
+                        "class_name": "DOQueueHandler",
+                        "script_name": "gitbook-open-v2-do-staging"
+                    }
+                ]
+            },
+            "migrations": [
+                {
+                    "tag": "v1",
+                    "new_sqlite_classes": ["DOQueueHandler", "DOShardedTagCache"]
+                }
+            ]
+        },
+        "production": {
+            "vars": {
+                // This is a bit misleading, but it means that we can have 500 concurrent revalidations
+                // This means that we'll have up to 100 durable objects instance running at the same time
+                "MAX_REVALIDATE_CONCURRENCY": "100",
+                // Temporary variable to find the issue once deployed
+                // TODO: remove this once the issue is fixed
+                "DEBUG_CLOUDFLARE": "true",
+                "WORKER_VERSION_ID": "TO_REPLACE",
+                "STAGE": "production"
+            },
+            "routes": [
+                {
+                    "pattern": "open-2c.gitbook.com/*",
+                    "zone_name": "gitbook.com"
+                },
+                {
+                    "pattern": "static-2c.gitbook.com/*",
+                    "zone_name": "gitbook.com"
+                }
+            ],
+            "r2_buckets": [
+                {
+                    "binding": "NEXT_INC_CACHE_R2_BUCKET",
+                    "bucket_name": "gitbook-open-v2-cache-production"
+                }
+            ],
+            "services": [
+                {
+                    "binding": "WORKER_SELF_REFERENCE",
+                    "service": "gitbook-open-v2-production"
+                },
+                {
+                    "binding": "DEFAULT_WORKER",
+                    "service": "gitbook-open-v2-server-production"
+                }
+            ],
+            "tail_consumers": [
+                {
+                    "service": "gitbook-x-prod-tail"
+                }
+            ],
+            "durable_objects": {
+                "bindings": [
+                    {
+                        "name": "WRITE_BUFFER",
+                        "class_name": "R2WriteBuffer",
+                        "script_name": "gitbook-open-v2-do-production"
+                    },
+                    {
+                        "name": "NEXT_TAG_CACHE_DO_SHARDED",
+                        "class_name": "DOShardedTagCache",
+                        "script_name": "gitbook-open-v2-do-production"
+                    },
+                    {
+                        "name": "NEXT_CACHE_DO_QUEUE",
+                        "class_name": "DOQueueHandler",
+                        "script_name": "gitbook-open-v2-do-production"
+                    }
+                ]
+            },
+            "migrations": [
+                {
+                    "tag": "v1",
+                    "new_sqlite_classes": ["DOQueueHandler", "DOShardedTagCache"]
+                }
+            ]
+        }
+    }
+}

packages/gitbook/openNext/customWorkers/script/updateWrangler.ts

@@ -0,0 +1,26 @@
+// In this script, we use the args from the cli to update the PREVIEW_URL vars in the wrangler config file for the middleware
+import fs from 'node:fs';
+import path from 'node:path';
+
+const wranglerConfigPath = path.join(__dirname, '../middlewareWrangler.jsonc');
+
+const file = fs.readFileSync(wranglerConfigPath, 'utf-8');
+
+const args = process.argv.slice(2);
+// The versionId is in the format xxx-xxx-xxx-xxx, we need the first part to reconstruct the preview URL
+const versionId = args[0];
+
+// The preview URL is in the format https://<versionId>-gitbook-open-v2-server-preview.gitbook.workers.dev
+const previewHostname = `${versionId.split('-')[0]}-gitbook-open-v2-server-preview.gitbook.workers.dev`;
+
+let updatedFile = file.replace(
+    /"PREVIEW_HOSTNAME": "TO_REPLACE"/,
+    `"PREVIEW_HOSTNAME": "${previewHostname}"`
+);
+
+updatedFile = updatedFile.replaceAll(
+    /"WORKER_VERSION_ID": "TO_REPLACE"/g,
+    `"WORKER_VERSION_ID": "${versionId}"`
+);
+
+fs.writeFileSync(wranglerConfigPath, updatedFile);

packages/gitbook/openNext/incrementalCache.ts

@@ -0,0 +1,224 @@
+import { createHash } from 'node:crypto';
+
+import { trace } from '@/lib/tracing';
+import type {
+    CacheEntryType,
+    CacheValue,
+    IncrementalCache,
+    WithLastModified,
+} from '@opennextjs/aws/types/overrides.js';
+import { getCloudflareContext } from '@opennextjs/cloudflare';
+
+import type { DurableObjectNamespace, Rpc } from '@cloudflare/workers-types';
+
+export const BINDING_NAME = 'NEXT_INC_CACHE_R2_BUCKET';
+export const DEFAULT_PREFIX = 'incremental-cache';
+
+export type KeyOptions = {
+    cacheType?: CacheEntryType;
+};
+
+/**
+ *
+ * It is very similar to the `R2IncrementalCache` in the `@opennextjs/cloudflare` package, but it allow us to trace
+ * the cache operations. It also integrates both R2 and Cache API in a single class.
+ * Having our own, will allow us to customize it in the future if needed.
+ */
+class GitbookIncrementalCache implements IncrementalCache {
+    name = 'GitbookIncrementalCache';
+
+    protected localCache: Cache | undefined;
+
+    async get<CacheType extends CacheEntryType = 'cache'>(
+        key: string,
+        cacheType?: CacheType
+    ): Promise<WithLastModified<CacheValue<CacheType>> | null> {
+        const cacheKey = this.getR2Key(key, cacheType);
+        return trace(
+            {
+                operation: 'openNextIncrementalCacheGet',
+                name: cacheKey,
+            },
+            async (span) => {
+                span.setAttribute('cacheType', cacheType ?? 'cache');
+                const r2 = getCloudflareContext().env[BINDING_NAME];
+                const localCache = await this.getCacheInstance();
+                if (!r2) throw new Error('No R2 bucket');
+                try {
+                    // Check local cache first if available
+                    const localCacheEntry = await localCache.match(this.getCacheUrlKey(cacheKey));
+                    if (localCacheEntry) {
+                        span.setAttribute('cacheHit', 'local');
+                        const result = (await localCacheEntry.json()) as WithLastModified<
+                            CacheValue<CacheType>
+                        >;
+                        return this.returnNullOn404(result);
+                    }
+
+                    const r2Object = await r2.get(cacheKey);
+                    if (!r2Object) return null;
+
+                    span.setAttribute('cacheHit', 'r2');
+                    return this.returnNullOn404({
+                        value: await r2Object.json(),
+                        lastModified: r2Object.uploaded.getTime(),
+                    });
+                } catch (e) {
+                    console.error('Failed to get from cache', e);
+                    return null;
+                }
+            }
+        );
+    }
+
+    //TODO: This is a workaround to handle 404 responses in the cache.
+    // It should be handled by OpenNext cache interception directly. This should be removed once OpenNext cache interception is fixed.
+    returnNullOn404<CacheType extends CacheEntryType = 'cache'>(
+        cacheEntry: WithLastModified<CacheValue<CacheType>> | null
+    ): WithLastModified<CacheValue<CacheType>> | null {
+        if (!cacheEntry?.value) return null;
+        if ('meta' in cacheEntry.value && cacheEntry.value.meta?.status === 404) {
+            return null;
+        }
+        return cacheEntry;
+    }
+
+    async set<CacheType extends CacheEntryType = 'cache'>(
+        key: string,
+        value: CacheValue<CacheType>,
+        cacheType?: CacheType
+    ): Promise<void> {
+        const cacheKey = this.getR2Key(key, cacheType);
+        return trace(
+            {
+                operation: 'openNextIncrementalCacheSet',
+                name: cacheKey,
+            },
+            async (span) => {
+                span.setAttribute('cacheType', cacheType ?? 'cache');
+                const localCache = await this.getCacheInstance();
+
+                try {
+                    await this.writeToR2(cacheKey, JSON.stringify(value));
+
+                    //TODO: Check if there is any places where we don't have tags
+                    // Ideally we should always have tags, but in case we don't, we need to decide how to handle it
+                    // For now we default to a build ID tag, which allow us to invalidate the cache in case something is wrong in this deployment
+                    const tags = this.getTagsFromCacheEntry(value) ?? [
+                        `build_id/${process.env.NEXT_BUILD_ID}`,
+                    ];
+
+                    // We consider R2 as the source of truth, so we update the local cache
+                    // only after a successful R2 write
+                    await localCache.put(
+                        this.getCacheUrlKey(cacheKey),
+                        new Response(
+                            JSON.stringify({
+                                value,
+                                // Note: `Date.now()` returns the time of the last IO rather than the actual time.
+                                //       See https://developers.cloudflare.com/workers/reference/security-model/
+                                lastModified: Date.now(),
+                            }),
+                            {
+                                headers: {
+                                    // Cache-Control default to 30 minutes, will be overridden by `revalidate`
+                                    // In theory we should always get the `revalidate` value
+                                    'cache-control': `max-age=${value.revalidate ?? 60 * 30}`,
+                                    'cache-tag': tags.join(','),
+                                },
+                            }
+                        )
+                    );
+                } catch (e) {
+                    console.error('Failed to set to cache', e);
+                }
+            }
+        );
+    }
+
+    async delete(key: string): Promise<void> {
+        const cacheKey = this.getR2Key(key);
+        return trace(
+            {
+                operation: 'openNextIncrementalCacheDelete',
+                name: cacheKey,
+            },
+            async () => {
+                const r2 = getCloudflareContext().env[BINDING_NAME];
+                const localCache = await this.getCacheInstance();
+                if (!r2) throw new Error('No R2 bucket');
+
+                try {
+                    await r2.delete(cacheKey);
+
+                    // Here again R2 is the source of truth, so we delete from local cache first
+                    await localCache.delete(this.getCacheUrlKey(cacheKey));
+                } catch (e) {
+                    console.error('Failed to delete from cache', e);
+                }
+            }
+        );
+    }
+
+    async writeToR2(key: string, value: string): Promise<void> {
+        const env = getCloudflareContext().env as {
+            WRITE_BUFFER: DurableObjectNamespace<
+                Rpc.DurableObjectBranded & {
+                    write: (key: string, value: string) => Promise<void>;
+                }
+            >;
+        };
+        const id = env.WRITE_BUFFER.idFromName(key);
+
+        // A stub is a client used to invoke methods on the Durable Object
+        const stub = env.WRITE_BUFFER.get(id);
+
+        await stub.write(key, value);
+    }
+
+    async getCacheInstance(): Promise<Cache> {
+        if (this.localCache) return this.localCache;
+        this.localCache = await caches.open('incremental-cache');
+        return this.localCache;
+    }
+
+    // Utility function to generate keys for R2/Cache API
+    getR2Key(initialKey: string, cacheType: CacheEntryType = 'cache'): string {
+        let key = initialKey;
+        if (cacheType === 'composable') {
+            // For composable cache, we need to discard the build ID from the key
+            const [_buildId, ...restOfTheKey] = JSON.parse(initialKey);
+            key = JSON.stringify([...restOfTheKey]);
+        }
+
+        const hash = createHash('sha256').update(key).digest('hex');
+        return `${DEFAULT_PREFIX}/${cacheType === 'cache' ? process.env?.NEXT_BUILD_ID : 'dataCache'}/${hash}.${cacheType}`.replace(
+            /\/+/g,
+            '/'
+        );
+    }
+
+    getCacheUrlKey(cacheKey: string): string {
+        return `http://cache.local/${cacheKey}`;
+    }
+
+    getTagsFromCacheEntry<CacheType extends CacheEntryType>(
+        entry: CacheValue<CacheType>
+    ): string[] | undefined {
+        if ('tags' in entry && entry.tags) {
+            return entry.tags;
+        }
+
+        if ('meta' in entry && entry.meta && 'headers' in entry.meta && entry.meta.headers) {
+            const rawTags = entry.meta.headers['x-next-cache-tags'];
+            if (typeof rawTags === 'string') {
+                return rawTags.split(',');
+            }
+        }
+        if ('value' in entry) {
+            return entry.tags;
+        }
+    }
+}
+
+export default new GitbookIncrementalCache();

packages/gitbook/openNext/queue/middleware.ts

@@ -0,0 +1,14 @@
+import { trace } from '@/lib/tracing';
+import type { Queue } from '@opennextjs/aws/types/overrides.js';
+import { getCloudflareContext } from '@opennextjs/cloudflare';
+import doQueue from '@opennextjs/cloudflare/overrides/queue/do-queue';
+
+export default {
+    name: 'GitbookISRQueue',
+    send: async (msg) => {
+        return trace({ operation: 'gitbookISRQueueSend', name: msg.MessageBody.url }, async () => {
+            const { ctx } = getCloudflareContext();
+            ctx.waitUntil(doQueue.send(msg));
+        });
+    },
+} satisfies Queue;

packages/gitbook/openNext/queue/server.ts

@@ -0,0 +1,9 @@
+import type { Queue } from '@opennextjs/aws/types/overrides.js';
+
+export default {
+    name: 'GitbookISRQueue',
+    send: async (msg) => {
+        // We should never reach this point in the server. If that's the case, we should log it.
+        console.warn('GitbookISRQueue: send called on server side, this should not happen.', msg);
+    },
+} satisfies Queue;

packages/gitbook/openNext/tagCache/middleware.ts

@@ -0,0 +1,81 @@
+import { trace } from '@/lib/tracing';
+import type { NextModeTagCache } from '@opennextjs/aws/types/overrides.js';
+import doShardedTagCache from '@opennextjs/cloudflare/overrides/tag-cache/do-sharded-tag-cache';
+import { softTagFilter } from '@opennextjs/cloudflare/overrides/tag-cache/tag-cache-filter';
+
+const originalTagCache = doShardedTagCache({
+    baseShardSize: 12,
+    regionalCache: true,
+    // We can probably increase this value even further
+    regionalCacheTtlSec: 60,
+    shardReplication: {
+        numberOfSoftReplicas: 2,
+        numberOfHardReplicas: 1,
+        regionalReplication: {
+            defaultRegion: 'enam',
+        },
+    },
+});
+
+export default {
+    name: 'GitbookTagCache',
+    mode: 'nextMode',
+    getLastRevalidated: async (tags: string[]) => {
+        const tagsToCheck = tags.filter(softTagFilter);
+        if (tagsToCheck.length === 0) {
+            // If we reach here, it probably means that there is an issue that we'll need to address.
+            console.warn(
+                'getLastRevalidated - No valid tags to check for last revalidation, original tags:',
+                tags
+            );
+            return 0; // If no tags to check, return 0
+        }
+        return trace(
+            {
+                operation: 'gitbookTagCacheGetLastRevalidated',
+                name: tagsToCheck.join(', '),
+            },
+            async () => {
+                return await originalTagCache.getLastRevalidated(tagsToCheck);
+            }
+        );
+    },
+    hasBeenRevalidated: async (tags: string[], lastModified?: number) => {
+        const tagsToCheck = tags.filter(softTagFilter);
+        if (tagsToCheck.length === 0) {
+            // If we reach here, it probably means that there is an issue that we'll need to address.
+            console.warn(
+                'hasBeenRevalidated - No valid tags to check for revalidation, original tags:',
+                tags
+            );
+            return false; // If no tags to check, return false
+        }
+        return trace(
+            {
+                operation: 'gitbookTagCacheHasBeenRevalidated',
+                name: tagsToCheck.join(', '),
+            },
+            async () => {
+                const result = await originalTagCache.hasBeenRevalidated(tagsToCheck, lastModified);
+                return result;
+            }
+        );
+    },
+    writeTags: async (tags: string[]) => {
+        return trace(
+            {
+                operation: 'gitbookTagCacheWriteTags',
+                name: tags.join(', '),
+            },
+            async () => {
+                const tagsToWrite = tags.filter(softTagFilter);
+                if (tagsToWrite.length === 0) {
+                    console.warn('writeTags - No valid tags to write');
+                    return; // If no tags to write, exit early
+                }
+                // Write only the filtered tags
+                await originalTagCache.writeTags(tagsToWrite);
+            }
+        );
+    },
+} satisfies NextModeTagCache;

packages/gitbook/package.json

@@ -1,78 +1,79 @@
 {
     "name": "gitbook",
-    "version": "0.7.3",
+    "version": "0.13.1",
     "private": true,
-    "scripts": {
-        "dev": "env-cmd --silent -f ../../.env.local next dev",
-        "build": "next build",
-        "build:cloudflare": "next-on-pages --custom-entrypoint=./src/cloudflare-entrypoint.ts",
-        "start": "next start",
-        "typecheck": "tsc --noEmit",
-        "e2e": "playwright test e2e/internal.spec.ts",
-        "e2e-customers": "playwright test e2e/customers.spec.ts",
-        "unit": "bun test {src,packages}",
-        "generate": "gitbook-icons ./public/~gitbook/static/icons custom-icons && gitbook-math ./public/~gitbook/static/math",
-        "copy:icons": "gitbook-icons ./public/~gitbook/static/icons",
-        "clean": "rm -rf ./.next && rm -rf ./public/~gitbook/static/icons && rm -rf ./public/~gitbook/static/math"
-    },
     "dependencies": {
-        "@gitbook/api": "0.96.1",
+        "@gitbook/api": "catalog:",
-        "@gitbook/cache-do": "workspace:*",
         "@gitbook/cache-tags": "workspace:*",
+        "@opennextjs/cloudflare": "1.2.1",
+        "@sindresorhus/fnv1a": "^3.1.0",
+        "assert-never": "^1.2.1",
+        "jwt-decode": "^4.0.0",
+        "next": "^15.3.2",
+        "react": "^19.0.0",
+        "react-dom": "^19.0.0",
+        "rison": "^0.1.1",
+        "server-only": "^0.0.1",
+        "warn-once": "^0.1.1",
+        "object-identity": "^0.1.2",
         "@gitbook/colors": "workspace:*",
         "@gitbook/emoji-codepoints": "workspace:*",
         "@gitbook/icons": "workspace:*",
+        "@gitbook/fonts": "workspace:*",
         "@gitbook/openapi-parser": "workspace:*",
         "@gitbook/react-contentkit": "workspace:*",
         "@gitbook/react-math": "workspace:*",
         "@gitbook/react-openapi": "workspace:*",
         "@radix-ui/react-checkbox": "^1.0.4",
+        "@radix-ui/react-dropdown-menu": "^2.1.12",
         "@radix-ui/react-navigation-menu": "^1.2.3",
         "@radix-ui/react-popover": "^1.0.7",
-        "@sentry/nextjs": "8.35.0",
+        "@radix-ui/react-tooltip": "^1.1.8",
-        "@sindresorhus/fnv1a": "^3.1.0",
         "@tailwindcss/container-queries": "^0.1.1",
         "@tailwindcss/typography": "^0.5.16",
-        "@upstash/redis": "^1.27.1",
+        "ai": "^4.2.2",
-        "ajv": "^8.12.0",
-        "assert-never": "^1.2.1",
         "bun-types": "^1.1.20",
         "classnames": "^2.5.1",
+        "event-iterator": "^2.0.0",
         "framer-motion": "^10.16.14",
         "js-cookie": "^3.0.5",
         "jsontoxml": "^1.0.1",
         "katex": "^0.16.9",
         "mathjax": "^3.2.2",
         "mdast-util-to-markdown": "^2.1.2",
-        "memoizee": "^0.4.15",
+        "mdast-util-from-markdown": "^2.0.2",
-        "micromark": "^4.0.1",
+        "mdast-util-frontmatter": "^2.0.1",
+        "mdast-util-gfm": "^3.1.0",
         "micromark-extension-gfm": "^3.0.0",
-        "next": "14.2.23",
+        "micromark-extension-frontmatter": "^2.0.0",
+        "unist-util-remove": "^4.0.0",
+        "unist-util-visit": "^5.0.0",
+        "memoizee": "^0.4.17",
         "next-themes": "^0.2.1",
         "nuqs": "^2.2.3",
         "object-hash": "^3.0.0",
         "openapi-types": "^12.1.3",
-        "p-map": "^7.0.0",
+        "p-map": "^7.0.3",
         "parse-cache-control": "^1.0.1",
-        "react": "18.3.1",
-        "react-dom": "18.3.1",
         "react-hotkeys-hook": "^4.4.1",
-        "rison": "^0.1.1",
+        "rehype-sanitize": "^6.0.0",
-        "server-only": "^0.0.1",
+        "rehype-stringify": "^10.0.1",
-        "shiki": "^1.27.2",
+        "remark-gfm": "^4.0.1",
+        "remark-parse": "^11.0.0",
+        "remark-rehype": "^11.1.1",
+        "shiki": "^3.2.0",
         "tailwind-merge": "^2.2.0",
         "tailwind-shades": "^1.1.2",
+        "unified": "^11.0.5",
         "url-join": "^5.0.0",
         "usehooks-ts": "^3.1.0",
-        "ai": "^4.1.46",
+        "zustand": "^5.0.3",
-        "jwt-decode": "^4.0.0"
+        "image-size": "^2.0.2",
+        "direction": "^2.0.1"
     },
     "devDependencies": {
-        "@argos-ci/playwright": "^3.10.0",
+        "@argos-ci/playwright": "^5.0.5",
-        "@cloudflare/next-on-pages": "1.13.7",
+        "@playwright/test": "^1.51.1",
-        "vercel": "^39.3.0",
-        "@cloudflare/workers-types": "^4.20241230.0",
-        "@playwright/test": "^1.49.1",
         "@types/js-cookie": "^3.0.6",
         "@types/jsontoxml": "^1.0.5",
         "@types/jsonwebtoken": "^9.0.6",
@@ -90,8 +91,26 @@
         "jsonwebtoken": "^9.0.2",
         "postcss": "^8",
         "psi": "^4.1.0",
+        "stylelint": "^16.16.0",
         "tailwindcss": "^3.4.0",
         "ts-essentials": "^10.0.1",
-        "typescript": "^5.5.3"
+        "typescript": "^5.5.3",
+        "vercel": "^39.3.0"
+    },
+    "scripts": {
+        "generate": "gitbook-icons ./public/~gitbook/static/icons custom-icons && gitbook-math ./public/~gitbook/static/math && wrangler types",
+        "copy:icons": "gitbook-icons ./public/~gitbook/static/icons",
+        "clean": "rm -rf ./.next && rm -rf ./public/~gitbook/static/icons && rm -rf ./public/~gitbook/static/math",
+        "dev": "env-cmd --silent -f ../../.env.local next --turbopack",
+        "build": "next build",
+        "start": "next start",
+        "build:cloudflare": "opennextjs-cloudflare build",
+        "dev:cloudflare": "wrangler dev --port 8771 --env preview",
+        "dev:cf:middleware": "wrangler dev --port 8771 --inspector-port 9230 --env dev --config ./openNext/customWorkers/middlewareWrangler.jsonc",
+        "dev:cf:server": "wrangler dev --port 8772 --env dev --config ./openNext/customWorkers/defaultWrangler.jsonc",
+        "e2e": "playwright test e2e/internal.spec.ts e2e/pdf.spec.ts",
+        "e2e-customers": "playwright test e2e/customers.spec.ts",
+        "unit": "bun test {src,packages} --preload ./tests/preload-bun.ts",
+        "typecheck": "tsc --noEmit"
     }
 }

packages/gitbook/playwright.config.ts

@@ -18,5 +18,8 @@ export default defineConfig({
     use: {
         trace: 'on-first-retry',
         screenshot: 'only-on-failure',
+        contextOptions: {
+            reducedMotion: 'reduce',
+        },
     },
 });