Fix NPM_TOKEN used to publish packages (#2844 )

Version Packages (#2839 )
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2026-09-15 23:25:16 +00:00 · 2025-02-18 10:25:55 +01:00 · 2025-02-18 00:44:59 +01:00 · 2025-02-17 17:12:26 +01:00 · 2025-02-17 17:12:16 +01:00 · 2025-02-17 15:11:58 +01:00
318 changed files with 71279 additions and 4960 deletions
@@ -1 +1 @@
-1.1.40
+1.2.1
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Fix UI search without ask AI enabled and fix error with questions not returned from API
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Fix empty sitemap
@@ -1,5 +0,0 @@
---
-'gitbook': minor
---
-
-Adapt code to pull token from customer backend generated custom cookies
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Add support for keyboard marks
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Fix search no results error showing while there are results
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Log component stack in Sentry
@@ -1,5 +0,0 @@
---
-'gitbook': minor
---
-
-Reintroduce a safety check around search whilst we continue investigating caching.
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Apply antialiasing on any text that are not code inline/blocks to avoid contrast issues
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Handle security issue with cookies on Safari
@@ -1,5 +0,0 @@
---
-'gitbook': minor
---
-
-Investigate an issue causing caches to return empty objects instead of null/undefined.
@@ -1,5 +0,0 @@
---
-'@gitbook/react-openapi': minor
---
-
-Add an optional client context to get a callback called when the Scalar client is opened for a block.
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Fix vertical section overflow color
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Fix pass Sentry release properly
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Fix shrinking page icons
@@ -1,5 +0,0 @@
---
-'gitbook': minor
---
-
-Add support for sidebar background styles
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Start using tint in more places, TOC and PageAside
@@ -1,7 +0,0 @@
---
-'gitbook': patch
---
-
-Ignore invalid API calls to `getSiteRedirectFromSource` API
-
-To reduce the load on the API and also avoid errors.
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Remove KV cache backend and only rely on DO as an external cache backend
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Ignore errors from event flushing
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Simplify search results logic to investigate a bug
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Try to fix error on og image generation
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Improve emoji setup, align with GitBook app
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Downgrade to Next.js v14 to fix incompatibilities with next-on-pages causing multiple bugs.
@@ -1,5 +0,0 @@
---
-'gitbook': minor
---
-
-Fix an issue where the redirects of potentially malicious images were not going through.
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Fix zoom image view transition on Safari
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Position the variant picker in the ToC
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Make cookies access safer
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Fix Image blocks zoomable behaviour
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Handle Firefox security error on localStorage
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Fix errors from customization not found
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Improve contrast of search box placeholder
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Fix OG image generation for non-latin characters
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Simplify the `useHash` algo used.
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Ignore cache invalidation error from local backend
@@ -1,5 +0,0 @@
---
-'gitbook': minor
---
-
-Track events for site insights using the new dedicated API.
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Allow only good values for theme query parameter. Avoid having a 500 error when we pass an invalid value.
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Improve colour contrast of list item decoration
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Set Sentry release
@@ -1,6 +0,0 @@
---
-'@gitbook/react-openapi': minor
-'gitbook': minor
---
-
-Revert scalar to 1.0.87 to mitigate an issue with ApiClientModalProvider
@@ -1,6 +0,0 @@
---
-'@gitbook/react-contentkit': minor
-'gitbook': minor
---
-
-Send redirectOnError param to getPublishedContent when token is pulled from cookie
@@ -1,5 +0,0 @@
---
-'gitbook': minor
---
-
-Restyle PageAside to use sidebar list styles
@@ -1,5 +0,0 @@
---
-'@gitbook/react-contentkit': patch
---
-
-Fix potential invalid URL error in react-contentkit
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Avoid error on fetch by passing a string URL
@@ -1,5 +0,0 @@
---
-'gitbook': minor
---
-
-Fix an issue where search and Ask AI triggers unnecessary renders when in a Visitor Authenticated site.
@@ -1,5 +0,0 @@
---
-'gitbook': minor
---
-
-Track clicks on links (header, footer, content) for site insights.
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Fix code format overriding inline link styles
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Fix emojis display
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Fix server actions stability leading to no results found sometimes on search
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Lazy load iframely script to make page more responsive
@@ -1,7 +0,0 @@
---
-'gitbook': patch
---
-
-Implement a safer way to interact with localStorage.
-
-If it's disabled on the browser it should not throw error.
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Fix search UI behaviour
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Fix two issues where pages would crash due Recoil not behaving correctly in RSC.
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Fix dynamic tabs infinite loop
@@ -1,5 +0,0 @@
---
-'@gitbook/react-openapi': patch
---
-
-Prevent codemirror from loading multiple versions in scalar
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Fix error when accessing a change request not found
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Fix variant selector contrast for non-default themes
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Fix issue leading to increase the storage write and the stability of the platform
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Force route handler to be dynamic to avoid errors
@@ -1,5 +0,0 @@
---
-'@gitbook/react-openapi': patch
---
-
-Updated scalar depdenency
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Fix search loading state
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Disable C/C++ highlight temporarily
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Fix Sentry instrumentation
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Even safer localStorage
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Avoid errors on legacy browsers
@@ -1,5 +0,0 @@
---
-'gitbook': minor
---
-
-Add antialiasing for text rendering
@@ -1,5 +0,0 @@
---
-'gitbook': minor
---
-
-Improve readability of tables with hover style and vertical dividers
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Improve styling of header buttons with shadows and high-contrast styles
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Fix viewing PDF from space
@@ -1,5 +0,0 @@
---
-'gitbook': minor
---
-
-Image optimization endpoint redirects to underlying image URL if the signature is not the latest.
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Fix bullet list display on full size blocks
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Vertical orientation for sections list on sites without header
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Fix error when accessing some not found pages.
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Fix "Parser" language syntax highlighting
@@ -1,5 +0,0 @@
---
-'gitbook': minor
---
-
-Fix a vulnerability issue for images using an older version of the image signing parameter.
@@ -1,5 +0,0 @@
---
-'gitbook': minor
---
-
-Track an event into site insights when visitor is opening the Scalar API client.
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Upgrade Next.js to v15, upgrade Shiki and use JS RegExp engine
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Fix breadcrumbs emoji display + add contrast styles
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Fix server actions cache compromised. Leading to some bugs on frontend.
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Improve smoothness of scroll listener
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Fix variant dropdown styling in header
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Fix view transition error on Safari
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Bump `heading-3` font size to offset it from paragraphs
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Fix Sentry instrumentation server-side
@@ -1,5 +0,0 @@
---
-'gitbook': patch
---
-
-Remove animation on section tabs. Page is reloaded (for technical reasons), so the animation is not accurate here.
@@ -18,7 +18,8 @@ jobs:
            checks: write
            statuses: write
        outputs:
-            deployment_url: ${{ steps.deploy.outputs.deployment-url }}
+            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
+            deployment-alias-url: ${{ steps.deploy.outputs.deployment-alias-url }}
        steps:
            - name: Checkout
              uses: actions/checkout@v4
@@ -38,7 +39,7 @@ jobs:
                  echo "SENTRY_ENVIRONMENT=preview" >> $GITHUB_ENV
              if: 1 && !startsWith(github.ref, 'refs/heads/main')
            - name: Build Next.js with next-on-pages
-              run: bun run build:cloudflare
+              run: bun run turbo build:cloudflare
              env:
                  SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
                  NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: ${{ secrets.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY }}
@@ -74,26 +75,159 @@ jobs:
                    -H "Accept: application/vnd.github.v3+json" \
                    -d '{"state": "success", "target_url": "${{ steps.deploy.outputs.deployment-url }}", "description": "Deployed Preview URL for commit", "context": "cloudflare/preview"}' \
                    https://api.github.com/repos/${{ github.repository }}/statuses/${{ github.sha }}
-
+    deploy-v2-vercel:
+        name: Deploy v2 to Vercel
+        runs-on: ubuntu-latest
+        permissions:
+            contents: read
+            deployments: write
+            issues: write
+            pull-requests: write
+            checks: write
+            statuses: write
+        outputs:
+            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
+        env:
+            VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
+            VERCEL_PROJECT_ID: ${{ secrets.VERCEL_PROJECT_ID }}
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
+            - name: Install dependencies
+              run: bun install --frozen-lockfile
+              env:
+                  PUPPETEER_SKIP_DOWNLOAD: 1
+            - name: Sets env vars for production
+              run: |
+                  echo "VERCEL_ENVIRONMENT=production" >> $GITHUB_ENV
+                  echo "SENTRY_ENVIRONMENT=production" >> $GITHUB_ENV
+                  echo "GITBOOK_ASSETS_PREFIX=https://static.gitbook.com" >> $GITHUB_ENV
+              if: startsWith(github.ref, 'refs/heads/main')
+            - name: Sets env vars for preview
+              run: |
+                  echo "VERCEL_ENVIRONMENT=preview" >> $GITHUB_ENV
+                  echo "SENTRY_ENVIRONMENT=preview" >> $GITHUB_ENV
+              if: 1 && !startsWith(github.ref, 'refs/heads/main')
+            - name: Pull Vercel Environment Information
+              run: bun run vercel pull --yes --environment=$VERCEL_ENVIRONMENT --token=${{ secrets.VERCEL_TOKEN }}
+            - name: Build Project Artifacts
+              run: bun run vercel build --token=${{ secrets.VERCEL_TOKEN }}
+              env:
+                  SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
+                  NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: ${{ secrets.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY }}
+                  SENTRY_ORG: ${{ vars.SENTRY_ORG }}
+                  SENTRY_PROJECT: ${{ vars.SENTRY_PROJECT }}
+                  SENTRY_DSN: ${{ vars.SENTRY_DSN }}
+                  SENTRY_RELEASE: ${{ github.sha }}
+            - name: Deploy Project Artifacts to Vercel
+              id: deploy
+              run: |
+                  DEPLOYMENT_URL=$(bun run vercel deploy --prebuilt --token=${{ secrets.VERCEL_TOKEN }})
+                  echo "deployment-url=$DEPLOYMENT_URL" >> "$GITHUB_OUTPUT"
+            - name: Outputs
+              run: |
+                  echo "URL: ${{ steps.deploy.outputs.deployment-url }}"
+    deploy-v2-cloudflare:
+        name: Deploy v2 to Cloudflare Worker
+        runs-on: ubuntu-latest
+        permissions:
+            contents: read
+            deployments: write
+            issues: write
+            pull-requests: write
+            checks: write
+            statuses: write
+        outputs:
+            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
+        env:
+            VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
+            VERCEL_PROJECT_ID: ${{ secrets.VERCEL_PROJECT_ID }}
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
+            - name: Install dependencies
+              run: bun install --frozen-lockfile
+              env:
+                  PUPPETEER_SKIP_DOWNLOAD: 1
+            - name: Sets env vars for production
+              run: |
+                  echo "SENTRY_ENVIRONMENT=production" >> $GITHUB_ENV
+                  echo "GITBOOK_ASSETS_PREFIX=https://static.gitbook.com" >> $GITHUB_ENV
+              if: startsWith(github.ref, 'refs/heads/main')
+            - name: Sets env vars for preview
+              run: |
+                  echo "SENTRY_ENVIRONMENT=preview" >> $GITHUB_ENV
+              if: 1 && !startsWith(github.ref, 'refs/heads/main')
+            - name: Build worker
+              run: bun run turbo build:v2:cloudflare
+              env:
+                  SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
+                  NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: ${{ secrets.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY }}
+                  SENTRY_ORG: ${{ vars.SENTRY_ORG }}
+                  SENTRY_PROJECT: ${{ vars.SENTRY_PROJECT }}
+                  SENTRY_DSN: ${{ vars.SENTRY_DSN }}
+                  SENTRY_RELEASE: ${{ github.sha }}
+            - id: deploy
+              name: Deploy to Cloudflare
+              uses: cloudflare/wrangler-action@v3.11.0
+              with:
+                  apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+                  accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+                  workingDirectory: ./
+                  wranglerVersion: '3.82.0'
+                  command: versions upload --config ./packages/gitbook-v2/wrangler.toml
+            - name: Outputs
+              run: |
+                  echo "URL: ${{ steps.deploy.outputs.deployment-url }}"
+    comment-deployments:
+        runs-on: ubuntu-latest
+        name: Comment Deployments
+        if: always() && !startsWith(github.ref, 'refs/heads/main')
+        needs:
+            - deploy
+            - deploy-v2-vercel
+            - deploy-v2-cloudflare
+        steps:
            - name: Find GitHub Comment
              uses: peter-evans/find-comment@v3
              id: fc
-              if: 1 && !startsWith(github.ref, 'refs/heads/main')
              with:
                  issue-number: ${{ github.event.pull_request.number }}
                  comment-author: 'github-actions[bot]'
-                  body-includes: GitBook Preview
+                  body-includes: 'Summary of the deployments'

            - name: Create or update GitHub comment
              uses: peter-evans/create-or-update-comment@v4
-              if: 1 && !startsWith(github.ref, 'refs/heads/main')
              with:
                  comment-id: ${{ steps.fc.outputs.comment-id }}
                  issue-number: ${{ github.event.pull_request.number }}
                  body: |
-                      **GitBook Preview**
-                      Latest commit: [${{ steps.deploy.outputs.deployment-url }}](${{ steps.deploy.outputs.deployment-url }})
-                      PR: [${{ steps.deploy.outputs.deployment-alias-url }}](${{ steps.deploy.outputs.deployment-alias-url }})
+                      Summary of the deployments:
+
+                      ### Version 1 (production)
+
+                      | Version | URL | Status |
+                      | --- | --- | --- |
+                      | Latest commit | [${{ needs.deploy.outputs.deployment-url }}](${{ needs.deploy.outputs.deployment-url }}) | ${{ needs.deploy.result == 'success' && '✅' || '❌' }} |
+                      | PR | [${{ needs.deploy.outputs.deployment-alias-url }}](${{ needs.deploy.outputs.deployment-alias-url }}) | ${{ needs.deploy.result == 'success' && '✅' || '❌' }} |
+
+                      ### Version 2 (experimental)
+
+                      | Version | URL | Status |
+                      | --- | --- | --- |
+                      | Vercel | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}](${{ needs.deploy-v2-vercel.outputs.deployment-url }}) | ${{ needs.deploy-v2-vercel.result == 'success' && '✅' || '❌' }} |
+                      | Cloudflare | [${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}](${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}) | ${{ needs.deploy-v2-cloudflare.result == 'success' && '✅' || '❌' }} |
+
+                      ### Test content
+
+                      | Site | v1 | v2 |
+                      | --- | --- | --- |
+                      | GitBook | [${{ needs.deploy.outputs.deployment-url }}/docs.gitbook.com](${{ needs.deploy.outputs.deployment-url }}/docs.gitbook.com) | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}/static/url/docs.gitbook.com](${{ needs.deploy-v2-vercel.outputs.deployment-url }}/static/url/docs.gitbook.com) |
+                      | E2E | [${{ needs.deploy.outputs.deployment-url }}/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy.outputs.deployment-url }}/gitbook.gitbook.io/test-gitbook-open) | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}/static/url/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy-v2-vercel.outputs.deployment-url }}/static/url/gitbook.gitbook.io/test-gitbook-open) |
                  edit-mode: replace
    visual-testing:
        runs-on: ubuntu-latest
@@ -111,7 +245,7 @@ jobs:
            - name: Run Playwright tests
              run: bun e2e
              env:
-                  BASE_URL: ${{needs.deploy.outputs.deployment_url}}
+                  BASE_URL: ${{needs.deploy.outputs.deployment-url}}
                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
            - uses: actions/upload-artifact@v4
              if: ${{ !cancelled() }}
@@ -119,6 +253,31 @@ jobs:
                  name: playwright-test-results
                  path: packages/gitbook/test-results/
                  retention-days: 3
+    visual-testing-customers:
+        runs-on: ubuntu-latest
+        name: Visual Testing Customers
+        needs: deploy
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
+            - name: Install dependencies
+              run: bun install --frozen-lockfile
+            - name: Setup Playwright
+              uses: ./.github/actions/setup-playwright
+            - name: Run Playwright tests
+              run: bun e2e-customers
+              env:
+                  BASE_URL: ${{needs.deploy.outputs.deployment-url}}
+                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
+                  ARGOS_BUILD_NAME: 'customers'
+            - uses: actions/upload-artifact@v4
+              if: ${{ !cancelled() }}
+              with:
+                  name: playwright-test-results-customers
+                  path: packages/gitbook/test-results/
+                  retention-days: 3
    pagespeed-testing:
        runs-on: ubuntu-latest
        name: PageSpeed Testing
@@ -135,7 +294,7 @@ jobs:
            - name: Run pagespeed tests
              run: bun ./packages/gitbook/tests/pagespeed-testing.ts $DEPLOYMENT_URL
              env:
-                  DEPLOYMENT_URL: ${{needs.deploy.outputs.deployment_url}}
+                  DEPLOYMENT_URL: ${{needs.deploy.outputs.deployment-url}}
                  PAGESPEED_API_KEY: ${{ secrets.PAGESPEED_API_KEY }}
    format:
        runs-on: ubuntu-latest
@@ -32,7 +32,7 @@ jobs:
                  # Using a PAT instead of GITHUB_TOKEN because we need to run workflows when releases are created
                  # https://github.com/orgs/community/discussions/26875#discussioncomment-3253761
                  GITHUB_TOKEN: ${{ secrets.GH_PERSONAL_TOKEN }}
-                  NPM_TOKEN_READONLY: ${{ secrets.NPM_TOKEN_READONLY }}
+                  NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
                  CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
                  CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}
    release-preview:
@@ -1,5 +1,6 @@
 .next
 .vercel
+.open-next

 # Generated
 packages/emoji-codepoints/index.ts
@@ -35,8 +35,10 @@ To run a local version of this project, please follow these simple steps.

 ### Prerequisites

-   Node.js (Version: >=18.x)
-   Bun
+-   Node.js (Version: >=20.6)
+  - Use nvm for easy Node management
+-   Bun (Version: >=1.2.1)
+  - We use a text-based lockfile which isn't supported below 1.2.1

 ### Set up

@@ -2,9 +2,10 @@
    "name": "gitbook",
    "version": "0.1.0",
    "devDependencies": {
-        "@changesets/cli": "^2.27.7",
+        "@changesets/cli": "^2.27.12",
        "prettier": "^3.0.3",
-        "turbo": "^2.1.2"
+        "turbo": "^2.4.1-canary.2",
+        "vercel": "^39.3.0"
    },
    "packageManager": "bun@1.1.18",
    "overrides": {
@@ -14,9 +15,11 @@
    },
    "private": true,
    "scripts": {
-        "dev": "turbo run dev --ui=stream",
+        "dev": "turbo run dev",
+        "dev:v2": "turbo run dev:v2",
        "build": "turbo run build",
-        "build:cloudflare": "turbo run build:cloudflare",
+        "build:v2": "turbo run build:v2",
+        "clean-deps": "rm -rf node_modules && rm -rf packages/*/node_modules",
        "lint": "turbo run lint",
        "lint:fix": "turbo run lint -- --fix",
        "typecheck": "turbo run typecheck",
@@ -24,6 +27,7 @@
        "format:check": "prettier ./ --ignore-unknown --list-different",
        "unit": "turbo run unit",
        "e2e": "turbo run e2e",
+        "e2e-customers": "turbo run e2e-customers",
        "changeset": "changeset",
        "release": "turbo run release && changeset publish",
        "release:preview": "turbo run release:preview",
@@ -35,6 +39,6 @@
    ],
    "patchedDependencies": {
        "decode-named-character-reference@1.0.2": "patches/decode-named-character-reference@1.0.2.patch",
-        "@vercel/next@4.3.15": "patches/@vercel%2Fnext@4.3.15.patch"
+        "@vercel/next@4.4.2": "patches/@vercel%2Fnext@4.4.2.patch"
    }
 }
@@ -0,0 +1,8 @@
+# next.js
+/.next/
+
+# vercel
+.vercel
+
+# cloudflare
+.open-next
@@ -0,0 +1,7 @@
+# gitbook-v2
+
+## 0.1.0
+
+### Minor Changes
+
+-   cfccc44: Setup structure and deployment for new version
@@ -0,0 +1,104 @@
+# GitBook V2
+
+This package contains the code for an experiment new version of the GitBook renderer.
+
+The goals of this new version are:
+
+- Optimize rendering to leverage Next.js ISR and static rendering
+- Leverage Node.js runtime and bigger instances to render bigger content
+- Evaluate Vercel and Cloudflare deployment options
+
+## Deployment
+
+#### Vercel
+
+The new version is deployed automatically to Vercel using a Github Action on every push.
+
+#### Cloudflare with Opennext-js
+
+The new version is deployed automatically to Cloudflare using a Github Action on every push.
+
+## Potential issues
+
+- [ ] We can't use `dynamicIO` because our root layout needs to fetch the params (https://github.com/vercel/next.js/discussions/71927)
+- [ ] How to do `nonce` for static resources when we can't use `headers()` (dynamic API) (https://nextjs.org/docs/app/building-your-application/configuring/content-security-policy)
+
+## Structure
+
+#### Middleware:
+
+Goals:
+- Route between dynamic and static routes
+  - If a token is in the cookies => dynamic route
+  - If a token is in the url => dynamic route
+  - Else => static route
+- High performances:
+  - It should not rely on data fetching
+
+#### URLs to support:
+
+Content URLs:
+
+- `docs.company.com/page`
+  - Middleware: rewrite to `/static/url/docs.company.com/page`
+  - Page component renders the page
+- `docs.company2.com/section/page`
+  - Middleware: rewrite to `/static/url/docs.company2.com/section/page`
+  - Page component renders the page
+- `docs.company3.com/section/sitespace/page`
+  - Middleware: rewrite to `/static/url/docs.company3.com/section/sitespace/page`
+  - Page component renders the page
+
+Content URLs (adaptive content or visitor authentication):
+
+- `docs.company.com/page`
+  - Middleware:
+    - If a token is in the cookies or url => dynamic route
+    - Else => rewrite to `/dynamic/url/docs.company.com/page`
+  - Page component renders the page
+    - Read the token from the url query params or cookies
+
+
+PDF export URLs:
+
+- `docs.company.com/page/~gitbook/pdf`
+  - Middleware: rewrite to `/dynamic/pdf/docs.company.com/page`
+  - Page component renders the page
+
+Images resizing:
+
+- `docs.company.com/~gitbook/image`
+  - Middleware: rewrite to `/dynamic/image/docs.company.com`
+  - Route handlers process the request
+
+Preview URLs:
+
+- `open.gitbook.com/sites/site_abc/page` (or `open.gitbook.com/~site/site_abc/page` to stay compatible?)
+  - Middleware: no rewrite
+  - Page component renders the page (dynamic?)
+     - Read the token from the url query params
+     - Read customizations override from the url query params
+
+
+Space PDF URLs:
+
+- `open.gitbook.com/spaces/space_abc/pdf`
+  - Middleware: no rewrite
+  - Page component renders the page (dynamic?)
+     - Read the token from the url query params
+     - Read customizations override from the url query params
+
+Development:
+
+- `localhost:3000/sites/site_abc/page`
+
+#### Routes:
+
+- Content
+    - [ ] `/static/url/[[...url]]/page.tsx`
+    - [ ] `/dynamic/url/[[...url]]/page.tsx`
+- Images resizing
+    - [ ] `/dynamic/image/[hostname]/route.ts`
+- PDF export
+    - [ ] `/dynamic/pdf/[[...url]]/page.tsx`
+    - [ ] `/spaces/[space]/pdf/page.tsx`
@@ -0,0 +1,5 @@
+/// <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.
@@ -0,0 +1,15 @@
+// @ts-check
+
+/**
+ * @type {import('next').NextConfig}
+ */
+const nextConfig = {
+    experimental: {
+        useCache: true,
+
+        // We can't use dynamicIO because it doesn't accept reading params in the root layout
+        // dynamicIO: true,
+    },
+};
+
+export default nextConfig;
@@ -0,0 +1,30 @@
+// default open-next.config.ts file created by @opennextjs/cloudflare
+
+import cache from '@opennextjs/cloudflare/kvCache';
+
+const config = {
+    default: {
+        override: {
+            wrapper: 'cloudflare-node',
+            converter: 'edge',
+            incrementalCache: async () => cache,
+            tagCache: 'dummy',
+            queue: 'dummy',
+        },
+    },
+
+    middleware: {
+        external: true,
+        override: {
+            wrapper: 'cloudflare-edge',
+            converter: 'edge',
+            proxyExternalRequest: 'fetch',
+        },
+    },
+
+    dangerous: {
+        enableCacheInterception: false,
+    },
+};
+
+export default config;
@@ -0,0 +1,22 @@
+{
+    "name": "gitbook-v2",
+    "version": "0.1.0",
+    "private": true,
+    "dependencies": {
+        "next": "canary",
+        "react": "^19.0.0",
+        "react-dom": "^19.0.0",
+        "@gitbook/api": "^0.93.0"
+    },
+    "devDependencies": {
+        "@opennextjs/cloudflare": "^0.4.3"
+    },
+    "scripts": {
+        "dev:v2": "next",
+        "build": "next build",
+        "build:v2": "next build",
+        "start": "next start",
+        "build:v2:cloudflare": "opennextjs-cloudflare",
+        "dev:v2:cloudflare": "wrangler dev --port 8771"
+    }
+}
@@ -0,0 +1,15 @@
+import { SiteContentLayout } from '@/components/routes/SiteContentLayout';
+import { createDynamicSiteContext } from '@/lib/context';
+
+export default async function RootLayout({
+    params,
+    children,
+}: {
+    params: Promise<{ url: string[] }>;
+    children: React.ReactNode;
+}) {
+    const { url } = await params;
+    const context = await createDynamicSiteContext(url);
+
+    return <SiteContentLayout context={context}>{children}</SiteContentLayout>;
+}
--- a/Show More
+++ b/Show More
Author	SHA1	Message	Date
Greg Bergé	b29a885bae	Fix NPM_TOKEN used to publish packages (#2844 )	2025-02-18 10:25:55 +01:00
Samy Pessé	919da7f2c9	Version Packages (#2839 ) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>	2025-02-18 00:44:59 +01:00
Greg Bergé	d222c116e0	Fix avoid showing child attributes if empty (#2842 )	2025-02-17 17:12:26 +01:00
Greg Bergé	df840dac18	Avoid parsing example description (#2841 )	2025-02-17 17:12:16 +01:00
Nolann B.	f8d4c7697c	Fix schema validation error (#2820 )	2025-02-17 15:11:58 +01:00
Nolann B.	dddb4ecbb8	Fix OpenAPI long tab group description (#2838 )	2025-02-17 12:51:13 +01:00
Greg Bergé	470d10cb47	Mark GitBook v2 as private (#2837 )	2025-02-17 09:41:20 +01:00
Samy Pessé	dae11e9607	Version Packages (#2644 ) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>	2025-02-17 09:12:54 +01:00
Greg Bergé	3d1eb53708	Run visual testing on customers docs (#2833 ) Co-authored-by: Valentino Hudhra <v.hudhra@gmail.com> Co-authored-by: Valentino Hudhra <2587839+valentin0h@users.noreply.github.com>	2025-02-14 17:00:48 +01:00
Zeno Kapitein	a76c9a56a7	Flip card logic (#2835 )	2025-02-14 15:34:03 +01:00
Greg Bergé	eaad0d4e09	Fix visual testing logo flakiness (#2834 )	2025-02-14 12:16:45 +01:00
Greg Bergé	46edde9da6	Improve OpenAPI abstraction to be more flexible on usage (#2832 )	2025-02-14 10:41:09 +01:00
Nolann B.	dda0cc635e	Flatten OpenAPI security object (#2818 )	2025-02-13 16:44:06 +01:00
Greg Bergé	727bde2d16	Refactor and optimize OpenAPI parsing (#2830 )	2025-02-13 16:30:34 +01:00
Zeno Kapitein	9f30af1b33	Fix card layout for cards without cover (#2831 )	2025-02-13 15:13:03 +01:00
Zeno Kapitein	ff05e20537	Improvements to inline images in headings (#2829 )	2025-02-13 13:44:16 +01:00
Scott Cazan	53de5b13c1	Fix URL resolution in Site Sections for Ask (#2827 )	2025-02-13 09:22:11 +01:00
Zeno Kapitein	a025118f69	Change card layout depending on cover aspect ratio (#2828 )	2025-02-12 17:21:52 +01:00
Zeno Kapitein	71688a817b	Implement new themes (#2822 ) Co-authored-by: Valentino Hudhra <v.hudhra@gmail.com>	2025-02-12 15:37:41 +01:00
Zeno Kapitein	00c476ea7f	Fix typo in sticky page outline (#2826 )	2025-02-12 09:13:45 +01:00
Samy Pessé	5576906914	Fix table of content displaying arrow next to page with only hidden pages (#2825 )	2025-02-10 16:24:27 +01:00
Samy Pessé	d5aaccd2c4	Remove use of deprecated API createSitesPageFeedback (#2824 )	2025-02-10 13:20:33 +01:00
Samy Pessé	7059c2ba25	Fetch computed document (#2823 )	2025-02-07 23:09:16 +01:00
Brett Jephson	aaab157d49	Section groups visual bug fix (#2821 )	2025-02-07 15:53:51 +00:00
Greg Bergé	9943276c0c	Revert PR with bugs (#2819 )	2025-02-07 15:08:58 +01:00
Nolann B.	c31cf5243a	Sync tabs across all OpenAPI blocks (#2817 )	2025-02-07 13:15:06 +01:00
Nolann B.	0c03676efb	Improve OpenAPI Securities sample and headers (#2816 )	2025-02-07 12:35:46 +01:00
Nolann B.	883d10acf8	Support for OpenAPI references (#2813 )	2025-02-07 11:46:23 +01:00
Nolann B.	3e5e458118	Handle isArray schema type (#2815 )	2025-02-07 11:23:36 +01:00
Brett Jephson	0510b6f29e	Add section description (#2814 )	2025-02-06 16:53:48 +00:00
Zeno Kapitein	92b7668bf3	Fix header offset (#2812 )	2025-02-06 15:12:07 +01:00
Scott Cazan	3973b1cbf3	Handle unresolved references in OpenAPI response' (#2811 ) Co-authored-by: Steven H <steven@gitbook.io>	2025-02-06 11:25:42 +01:00
Nolann B.	160fca1ea1	Update OpenAPI design (#2787 )	2025-02-06 10:47:23 +01:00
Zeno Kapitein	e90c96f7e9	Page outline positioning (#2805 ) Co-authored-by: Claire Chabas <claire.chabas@gmail.com>	2025-02-05 17:08:30 +01:00
Scott Cazan	d935fb1b2e	Only push scrolling down when Footer is present (#2807 )	2025-02-05 12:26:31 +01:00
Scott Cazan	a6529584a5	Handle Errors from Unresolved Refs (#2810 )	2025-02-05 10:52:35 +00:00
Zeno Kapitein	18953b2d6b	Make tint color subtler when equal to primary color (#2808 ) Co-authored-by: Valentino Hudhra <2587839+valentin0h@users.noreply.github.com>	2025-02-05 11:40:19 +01:00
Zeno Kapitein	21cbd9e3b0	Change link color to primary subtle (#2809 )	2025-02-05 09:02:53 +01:00
Brett Jephson	38061bdf65	RND-5646: section groups navigation menu (#2789 )	2025-02-04 17:07:57 +00:00
Nolann B.	d9029c7e1e	Include apiKey example in CodeSample security headers (#2804 )	2025-02-04 17:19:39 +01:00
Steven H	fe8acc986e	Fix an issue where a missing OpenAPI example would crash the page. (#2806 )	2025-02-04 11:48:38 +00:00
Nolann B.	e721f17f7e	Implement Scalar's getExampleFromSchema (#2802 )	2025-02-04 11:59:47 +01:00
Nolann B.	2f73db785e	Support non primitive examples in OpenAPI block (#2775 )	2025-02-03 17:07:29 +01:00
Zeno Kapitein	9e18ae6587	Overhaul colour system & classes (#2783 )	2025-02-03 12:23:19 +01:00
Samy Pessé	9eca010f94	Improve display of recommended questions using streaming (#2800 )	2025-01-31 23:13:40 +01:00
Greg Bergé	6e54a06d9c	Support response examples in API blocks (#2799 )	2025-01-31 18:47:29 +01:00
Greg Bergé	1f8e416e41	Highlight code client-side (#2797 )	2025-01-31 13:47:37 +01:00
Samy Pessé	cfccc44406	Setup package and deployment for v2 (#2791 )	2025-01-31 12:28:41 +01:00
Claire Chabas	45b30c9c27	Fix icons generate script (#2798 )	2025-01-31 11:05:38 +01:00
Samy Pessé	67f78368fb	Revert "Highlight code client-side" (#2796 )	2025-01-30 20:09:57 +01:00
Greg Bergé	d9c8d57e8e	Avoid dereferencing before caching (#2793 )	2025-01-30 17:15:19 +01:00
Greg Bergé	0d615e3888	Highlight code client-side (#2786 )	2025-01-30 16:08:39 +01:00
Greg Bergé	68287d3df4	Cache API spec for 24 hours, revalidated every 2 hours (#2792 )	2025-01-30 15:16:45 +01:00
Greg Bergé	dff08ae3e3	Load Scalar only when the button is pressed (#2790 )	2025-01-30 15:01:59 +01:00
Zeno Kapitein	8cfa67c1dd	Fix default outline list styling (#2788 )	2025-01-30 13:56:43 +01:00
Greg Bergé	b41d425993	Improve OpenAPI performances (#2784 )	2025-01-30 11:13:01 +01:00
Greg Bergé	12c7862250	Use Scalar OpenAPI parser (#2780 )	2025-01-30 08:44:08 +01:00
Greg Bergé	6f54826296	Replace highlight colors (#2781 )	2025-01-29 15:00:01 +01:00
Steven H	ccf2cffc4b	Hotfix docs.radiantdrift.com crashing in production. (#2782 )	2025-01-29 12:42:01 +00:00
Zeno Kapitein	f7b801b4c8	Support user comments after rating (#2771 ) Co-authored-by: Samy Pessé <samypesse@gmail.com>	2025-01-28 09:39:32 +01:00
Samy Pessé	95f2aa45eb	Integration with new site insights (#2777 )	2025-01-28 09:18:50 +01:00
Samy Pessé	9524ff5f5a	Migrate to bun text-based lockfile (#2770 )	2025-01-28 08:47:40 +01:00
Steven H	1823101b03	Fix internal properties appearing in OpenAPI docs. (#2774 )	2025-01-23 21:35:06 +00:00
Samy Pessé	1a8cfd2a8b	Hide toolbar when previewing (#2773 )	2025-01-23 21:58:02 +01:00
Greg Bergé	5b4e710770	Support llms.txt (#2768 )	2025-01-23 16:37:45 +01:00
Zeno Kapitein	1762f85ef9	Reduce gap between subsequent header buttons (#2765 )	2025-01-23 14:10:47 +01:00
Samy Pessé	d370a3f0e3	Align the revisions/changes path for multi-id with the normal one (#2769 )	2025-01-23 10:00:11 +01:00
Greg Bergé	d3e573c2e9	Generate sitemap for all sections and spaces (#2767 )	2025-01-22 16:57:57 +01:00
Zeno Kapitein	94876e3ad1	Fix regression issue with page icons for multi-line titles (#2764 )	2025-01-21 17:03:33 +01:00
Zeno Kapitein	ad190602c7	Tweak card background, better margins for card headings (#2763 )	2025-01-21 17:03:22 +01:00
Scott Cazan	162b4b78b6	Add HTTP examples to API blocks (#2759 )	2025-01-21 15:34:42 +01:00
Zeno Kapitein	e5dc05e994	Restyle footer, allow >4 link groups (#2761 )	2025-01-21 14:50:33 +01:00
@@ -1 +1 @@
 .1.40
 .2.1