mirror of
https://github.com/GitbookIO/gitbook.git
synced 2026-09-27 12:39:08 +00:00
Compare commits
25 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 9e11b009f6 | |||
| ce9dc0560e | |||
| 6f8a80712b | |||
| dda46c1086 | |||
| 0acc1c497b | |||
| bd9a3671e5 | |||
| 7212973f34 | |||
| af44e0436b | |||
| 3f9c35d505 | |||
| 2c13f8b95c | |||
| 4dab1c56e5 | |||
| 4723f03ef1 | |||
| 278689e0a0 | |||
| 886e204e68 | |||
| c59947ab39 | |||
| 4f0a772a21 | |||
| 903f962673 | |||
| 31d800e48b | |||
| c1c58eb919 | |||
| eec3eed100 | |||
| 99da8df3d1 | |||
| c9ea23919e | |||
| 16292def79 | |||
| 9108c56ca1 | |||
| b011ea0af8 |
@@ -1,5 +0,0 @@
|
||||
---
|
||||
'@gitbook/react-contentkit': minor
|
||||
---
|
||||
|
||||
Fix an issue where ContentKit iframes were not resizing.
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"gitbook": patch
|
||||
---
|
||||
|
||||
Fix alignment of `prominent` search bar on full-width pages
|
||||
@@ -1,5 +0,0 @@
|
||||
---
|
||||
'gitbook': patch
|
||||
---
|
||||
|
||||
Transparent background for OpenAPI path block
|
||||
@@ -1,5 +0,0 @@
|
||||
---
|
||||
'@gitbook/react-openapi': patch
|
||||
---
|
||||
|
||||
Handle read-only in OpenAPISchemaName
|
||||
@@ -0,0 +1,6 @@
|
||||
---
|
||||
"@gitbook/openapi-parser": patch
|
||||
"@gitbook/react-openapi": patch
|
||||
---
|
||||
|
||||
Update scalar
|
||||
@@ -1,5 +0,0 @@
|
||||
---
|
||||
'gitbook': patch
|
||||
---
|
||||
|
||||
Info hint background and link color fixes
|
||||
@@ -1,5 +0,0 @@
|
||||
---
|
||||
'@gitbook/react-openapi': patch
|
||||
---
|
||||
|
||||
Remove read-only properties from codesample
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"gitbook": patch
|
||||
---
|
||||
|
||||
Restyle section group dropdown
|
||||
@@ -1,5 +0,0 @@
|
||||
---
|
||||
'@gitbook/cache-tags': minor
|
||||
---
|
||||
|
||||
Export function `getCacheTagForURL` to easily get the cache tag for a URL.
|
||||
@@ -35,21 +35,11 @@ jobs:
|
||||
- name: Sets env vars for production
|
||||
if: github.ref == 'refs/heads/main'
|
||||
run: |
|
||||
echo "SENTRY_ENVIRONMENT=production" >> $GITHUB_ENV
|
||||
echo "GITBOOK_ASSETS_PREFIX=https://static.gitbook.com" >> $GITHUB_ENV
|
||||
- name: Sets env vars for preview
|
||||
if: github.ref != 'refs/heads/main'
|
||||
run: |
|
||||
echo "SENTRY_ENVIRONMENT=preview" >> $GITHUB_ENV
|
||||
- name: Build Next.js with next-on-pages
|
||||
run: bun run turbo gitbook#build:cloudflare
|
||||
env:
|
||||
SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
|
||||
NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: ${{ secrets.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY }}
|
||||
SENTRY_ORG: ${{ vars.SENTRY_ORG }}
|
||||
SENTRY_PROJECT: ${{ vars.SENTRY_PROJECT }}
|
||||
SENTRY_DSN: ${{ vars.SENTRY_DSN }}
|
||||
SENTRY_RELEASE: ${{ github.sha }}
|
||||
- id: deploy
|
||||
name: Deploy to Cloudflare
|
||||
uses: cloudflare/wrangler-action@v3.14.0
|
||||
|
||||
+1
-1
@@ -12,7 +12,7 @@
|
||||
"@codemirror/state": "6.4.1",
|
||||
"react": "18.3.1",
|
||||
"react-dom": "18.3.1",
|
||||
"@gitbook/api": "0.97.0"
|
||||
"@gitbook/api": "0.99.0"
|
||||
},
|
||||
"private": true,
|
||||
"scripts": {
|
||||
|
||||
@@ -1,7 +1,13 @@
|
||||
# @gitbook/cache-tags
|
||||
|
||||
## 0.2.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- f32bf1f: Export function `getCacheTagForURL` to easily get the cache tag for a URL.
|
||||
|
||||
## 0.1.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- 05ffd0e: Initial version of the package
|
||||
- 05ffd0e: Initial version of the package
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
"default": "./dist/index.js"
|
||||
}
|
||||
},
|
||||
"version": "0.1.0",
|
||||
"version": "0.2.0",
|
||||
"dependencies": {
|
||||
"@gitbook/api": "*",
|
||||
"assert-never": "^1.2.1"
|
||||
|
||||
@@ -1,7 +1,13 @@
|
||||
# @gitbook/colors
|
||||
|
||||
## 0.3.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- 4f0a772: Override tint lightness if supplied color is out of bounds
|
||||
|
||||
## 0.2.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- 445baaa: Initial release
|
||||
- 445baaa: Initial release
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
"default": "./dist/index.js"
|
||||
}
|
||||
},
|
||||
"version": "0.2.0",
|
||||
"version": "0.3.0",
|
||||
"devDependencies": {
|
||||
"typescript": "^5.5.3"
|
||||
},
|
||||
|
||||
@@ -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 = [];
|
||||
|
||||
|
||||
@@ -1,27 +1,34 @@
|
||||
# gitbook-v2
|
||||
|
||||
## 0.2.1
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [f32bf1f]
|
||||
- @gitbook/cache-tags@0.2.0
|
||||
|
||||
## 0.2.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- 76c7974: Add route to revalidate cached data
|
||||
- 76c7974: Add route to revalidate cached data
|
||||
|
||||
## 0.1.2
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 05ffd0e: Improving data cache management for computed content
|
||||
- Updated dependencies [05ffd0e]
|
||||
- @gitbook/cache-tags@0.1.0
|
||||
- 05ffd0e: Improving data cache management for computed content
|
||||
- Updated dependencies [05ffd0e]
|
||||
- @gitbook/cache-tags@0.1.0
|
||||
|
||||
## 0.1.1
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 3e11678: fix: lost section groups
|
||||
- 3e11678: fix: lost section groups
|
||||
|
||||
## 0.1.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- cfccc44: Setup structure and deployment for new version
|
||||
- cfccc44: Setup structure and deployment for new version
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "gitbook-v2",
|
||||
"version": "0.2.0",
|
||||
"version": "0.2.1",
|
||||
"private": true,
|
||||
"dependencies": {
|
||||
"next": "^15.2.1",
|
||||
|
||||
@@ -23,8 +23,5 @@
|
||||
## Caching
|
||||
# GITBOOK_OUTPUT_CACHE=true
|
||||
|
||||
### Sentry ###
|
||||
# SENTRY_DSN=xxx
|
||||
|
||||
### Silent logs
|
||||
# SILENT=true
|
||||
@@ -23,9 +23,6 @@ next-env.d.ts
|
||||
# visual tests
|
||||
screenshots/
|
||||
|
||||
# Sentry Config File
|
||||
.sentryclirc
|
||||
|
||||
/test-results/
|
||||
/playwright-report/
|
||||
/blob-report/
|
||||
|
||||
+391
-356
@@ -1,461 +1,496 @@
|
||||
# gitbook
|
||||
|
||||
## 0.8.1
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 886e204: Update OpenAPI operation path design
|
||||
- Updated dependencies [886e204]
|
||||
- Updated dependencies [4f0a772]
|
||||
- @gitbook/react-openapi@1.1.5
|
||||
- @gitbook/colors@0.3.0
|
||||
|
||||
## 0.8.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- eec3eed: Add styling for prominent search bar option
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 16292de: Display sidebar on no-TOC pages
|
||||
- 9b5f971: Transparent background for OpenAPI path block
|
||||
- 99da8df: Optimize favicons and og:image using the image resizer
|
||||
- b011ea0: Fix rendering of code blocks in Ask AI when being streamed
|
||||
- 9bc3d50: Info hint background and link color fixes
|
||||
- 31d800e: Render OpenAPISchemas block
|
||||
- Updated dependencies [6aaeae2]
|
||||
- Updated dependencies [c60e9ba]
|
||||
- Updated dependencies [9108c56]
|
||||
- Updated dependencies [31d800e]
|
||||
- Updated dependencies [ff3b708]
|
||||
- Updated dependencies [f32bf1f]
|
||||
- Updated dependencies [c9ea239]
|
||||
- @gitbook/react-contentkit@0.7.0
|
||||
- @gitbook/react-openapi@1.1.4
|
||||
- @gitbook/cache-tags@0.2.0
|
||||
|
||||
## 0.7.3
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- eaf2d68: OpenAPI operation title fallback in sections
|
||||
- Updated dependencies [844059f]
|
||||
- Updated dependencies [88f64b0]
|
||||
- @gitbook/react-openapi@1.1.3
|
||||
- @gitbook/icons@0.2.0
|
||||
- @gitbook/react-contentkit@0.6.2
|
||||
- eaf2d68: OpenAPI operation title fallback in sections
|
||||
- Updated dependencies [844059f]
|
||||
- Updated dependencies [88f64b0]
|
||||
- @gitbook/react-openapi@1.1.3
|
||||
- @gitbook/icons@0.2.0
|
||||
- @gitbook/react-contentkit@0.6.2
|
||||
|
||||
## 0.7.2
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- f127d28: Rename OpenAPIModels to OpenAPISchemas
|
||||
- Updated dependencies [f127d28]
|
||||
- @gitbook/react-openapi@1.1.2
|
||||
- f127d28: Rename OpenAPIModels to OpenAPISchemas
|
||||
- Updated dependencies [f127d28]
|
||||
- @gitbook/react-openapi@1.1.2
|
||||
|
||||
## 0.7.1
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [f574858]
|
||||
- @gitbook/react-openapi@1.1.1
|
||||
- Updated dependencies [f574858]
|
||||
- @gitbook/react-openapi@1.1.1
|
||||
|
||||
## 0.7.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- bb3ca9c: Implement OpenAPI models blocks
|
||||
- bb3ca9c: Implement OpenAPI models blocks
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 5907bd9: Adjust hint block spacing
|
||||
- 9ffc3b6: Fix content overflowing out of its container in tabs
|
||||
- Updated dependencies [0278a14]
|
||||
- Updated dependencies [bb3ca9c]
|
||||
- Updated dependencies [3173d8e]
|
||||
- Updated dependencies [052e07a]
|
||||
- @gitbook/openapi-parser@2.1.0
|
||||
- @gitbook/react-openapi@1.1.0
|
||||
- 5907bd9: Adjust hint block spacing
|
||||
- 9ffc3b6: Fix content overflowing out of its container in tabs
|
||||
- Updated dependencies [0278a14]
|
||||
- Updated dependencies [bb3ca9c]
|
||||
- Updated dependencies [3173d8e]
|
||||
- Updated dependencies [052e07a]
|
||||
- @gitbook/openapi-parser@2.1.0
|
||||
- @gitbook/react-openapi@1.1.0
|
||||
|
||||
## 0.6.5
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 05ffd0e: Improving data cache management for computed content
|
||||
- 8beb5d6: Add input elements to ContentKit
|
||||
- Updated dependencies [53f5dbe]
|
||||
- Updated dependencies [05ffd0e]
|
||||
- Updated dependencies [8beb5d6]
|
||||
- @gitbook/openapi-parser@2.0.2
|
||||
- @gitbook/cache-tags@0.1.0
|
||||
- @gitbook/react-contentkit@0.6.1
|
||||
- @gitbook/react-openapi@1.0.5
|
||||
- 05ffd0e: Improving data cache management for computed content
|
||||
- 8beb5d6: Add input elements to ContentKit
|
||||
- Updated dependencies [53f5dbe]
|
||||
- Updated dependencies [05ffd0e]
|
||||
- Updated dependencies [8beb5d6]
|
||||
- @gitbook/openapi-parser@2.0.2
|
||||
- @gitbook/cache-tags@0.1.0
|
||||
- @gitbook/react-contentkit@0.6.1
|
||||
- @gitbook/react-openapi@1.0.5
|
||||
|
||||
## 0.6.4
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 9b914d1: Fix getProxyModeBasePath that was computing incorrect base path in some scenarios
|
||||
- 2ae76f9: Change how a site in proxy mode is resolved
|
||||
- 027a859: Add support for links style customization option
|
||||
- 3e11678: fix: lost section groups
|
||||
- 3319375: Support OpenAPI operation block
|
||||
- Updated dependencies [722f02e]
|
||||
- Updated dependencies [0924259]
|
||||
- @gitbook/react-openapi@1.0.4
|
||||
- @gitbook/openapi-parser@2.0.1
|
||||
- 9b914d1: Fix getProxyModeBasePath that was computing incorrect base path in some scenarios
|
||||
- 2ae76f9: Change how a site in proxy mode is resolved
|
||||
- 027a859: Add support for links style customization option
|
||||
- 3e11678: fix: lost section groups
|
||||
- 3319375: Support OpenAPI operation block
|
||||
- Updated dependencies [722f02e]
|
||||
- Updated dependencies [0924259]
|
||||
- @gitbook/react-openapi@1.0.4
|
||||
- @gitbook/openapi-parser@2.0.1
|
||||
|
||||
## 0.6.3
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- a820739: Remove unused search api method from gitbook/api/lib
|
||||
- a054554: Implement a trusted mode to speed up OpenAPI spec validation
|
||||
- 66d0fc0: Update design for hint block: use semantic colors (info, warning, danger, success) and add alternative styling for hints with headings
|
||||
- 9f0de74: Add support for new OpenAPI ref
|
||||
- da55fac: Render GitBook blocks in OpenAPI operation description
|
||||
- Updated dependencies [c808bb1]
|
||||
- Updated dependencies [dc2dbc5]
|
||||
- Updated dependencies [f1d1d2f]
|
||||
- Updated dependencies [e24206e]
|
||||
- Updated dependencies [a054554]
|
||||
- Updated dependencies [05e1d8c]
|
||||
- Updated dependencies [b4a12d6]
|
||||
- Updated dependencies [9f0de74]
|
||||
- Updated dependencies [da55fac]
|
||||
- @gitbook/openapi-parser@2.0.0
|
||||
- @gitbook/react-openapi@1.0.3
|
||||
- a820739: Remove unused search api method from gitbook/api/lib
|
||||
- a054554: Implement a trusted mode to speed up OpenAPI spec validation
|
||||
- 66d0fc0: Update design for hint block: use semantic colors (info, warning, danger, success) and add alternative styling for hints with headings
|
||||
- 9f0de74: Add support for new OpenAPI ref
|
||||
- da55fac: Render GitBook blocks in OpenAPI operation description
|
||||
- Updated dependencies [c808bb1]
|
||||
- Updated dependencies [dc2dbc5]
|
||||
- Updated dependencies [f1d1d2f]
|
||||
- Updated dependencies [e24206e]
|
||||
- Updated dependencies [a054554]
|
||||
- Updated dependencies [05e1d8c]
|
||||
- Updated dependencies [b4a12d6]
|
||||
- Updated dependencies [9f0de74]
|
||||
- Updated dependencies [da55fac]
|
||||
- @gitbook/openapi-parser@2.0.0
|
||||
- @gitbook/react-openapi@1.0.3
|
||||
|
||||
## 0.6.2
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 359bb97: Fix opening external links when the GitBook page is embedded in an iframe
|
||||
- 6157583: Improve Markdown parsing
|
||||
- 82cd9f2: Add support for anchor links in OpenAPI blocks
|
||||
- Updated dependencies [445baaa]
|
||||
- Updated dependencies [bb5c6a4]
|
||||
- Updated dependencies [a3f1fea]
|
||||
- Updated dependencies [6157583]
|
||||
- Updated dependencies [7419ee7]
|
||||
- Updated dependencies [82cd9f2]
|
||||
- @gitbook/colors@0.2.0
|
||||
- @gitbook/react-openapi@1.0.2
|
||||
- @gitbook/openapi-parser@1.0.1
|
||||
- 359bb97: Fix opening external links when the GitBook page is embedded in an iframe
|
||||
- 6157583: Improve Markdown parsing
|
||||
- 82cd9f2: Add support for anchor links in OpenAPI blocks
|
||||
- Updated dependencies [445baaa]
|
||||
- Updated dependencies [bb5c6a4]
|
||||
- Updated dependencies [a3f1fea]
|
||||
- Updated dependencies [6157583]
|
||||
- Updated dependencies [7419ee7]
|
||||
- Updated dependencies [82cd9f2]
|
||||
- @gitbook/colors@0.2.0
|
||||
- @gitbook/react-openapi@1.0.2
|
||||
- @gitbook/openapi-parser@1.0.1
|
||||
|
||||
## 0.6.1
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- dddb4ec: Fix long tab group description
|
||||
- Updated dependencies [f8d4c76]
|
||||
- Updated dependencies [dddb4ec]
|
||||
- Updated dependencies [f8d4c76]
|
||||
- @gitbook/react-openapi@1.0.1
|
||||
- dddb4ec: Fix long tab group description
|
||||
- Updated dependencies [f8d4c76]
|
||||
- Updated dependencies [dddb4ec]
|
||||
- Updated dependencies [f8d4c76]
|
||||
- @gitbook/react-openapi@1.0.1
|
||||
|
||||
## 0.6.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- 98245e5: Adapt code to pull token from customer backend generated custom cookies
|
||||
- af3c6a9: Reintroduce a safety check around search whilst we continue investigating caching.
|
||||
- 95f2aa4: Track new events for site insights when ads are being clicked
|
||||
- 08acea6: Investigate an issue causing caches to return empty objects instead of null/undefined.
|
||||
- 1138d59: Add support for sidebar background styles
|
||||
- 9e18ae6: Overhaul colour scale & Tailwind colour classes
|
||||
- e86e51f: Fix an issue where the redirects of potentially malicious images were not going through.
|
||||
- 7059c2b: Add support for computed content by fetching computed documents for pages.
|
||||
- c71d159: Track events for site insights using the new dedicated API.
|
||||
- eb7c22f: Revert scalar to 1.0.87 to mitigate an issue with ApiClientModalProvider
|
||||
- ea1468c: Send redirectOnError param to getPublishedContent when token is pulled from cookie
|
||||
- 7ee9158: Restyle PageAside to use sidebar list styles
|
||||
- dbba50c: Fix an issue where search and Ask AI triggers unnecessary renders when in a Visitor Authenticated site.
|
||||
- 1417279: Track clicks on links (header, footer, content) for site insights.
|
||||
- 9eca010: Improve the display of recommended questions by streaming them.
|
||||
- 160fca1: new OpenAPI blocks design
|
||||
- 71688a8: Introduction of new themes: Clean, Muted, Bold, and Gradient
|
||||
- 1823101: Fix internal properties appearing in OpenAPI docs.
|
||||
- 6a073e1: Add antialiasing for text rendering
|
||||
- 8126a83: Improve readability of tables with hover style and vertical dividers
|
||||
- db74ea3: Image optimization endpoint redirects to underlying image URL if the signature is not the latest.
|
||||
- 99579ac: Fix a vulnerability issue for images using an older version of the image signing parameter.
|
||||
- e4e2f52: Track an event into site insights when visitor is opening the Scalar API client.
|
||||
- 98245e5: Adapt code to pull token from customer backend generated custom cookies
|
||||
- af3c6a9: Reintroduce a safety check around search whilst we continue investigating caching.
|
||||
- 95f2aa4: Track new events for site insights when ads are being clicked
|
||||
- 08acea6: Investigate an issue causing caches to return empty objects instead of null/undefined.
|
||||
- 1138d59: Add support for sidebar background styles
|
||||
- 9e18ae6: Overhaul colour scale & Tailwind colour classes
|
||||
- e86e51f: Fix an issue where the redirects of potentially malicious images were not going through.
|
||||
- 7059c2b: Add support for computed content by fetching computed documents for pages.
|
||||
- c71d159: Track events for site insights using the new dedicated API.
|
||||
- eb7c22f: Revert scalar to 1.0.87 to mitigate an issue with ApiClientModalProvider
|
||||
- ea1468c: Send redirectOnError param to getPublishedContent when token is pulled from cookie
|
||||
- 7ee9158: Restyle PageAside to use sidebar list styles
|
||||
- dbba50c: Fix an issue where search and Ask AI triggers unnecessary renders when in a Visitor Authenticated site.
|
||||
- 1417279: Track clicks on links (header, footer, content) for site insights.
|
||||
- 9eca010: Improve the display of recommended questions by streaming them.
|
||||
- 160fca1: new OpenAPI blocks design
|
||||
- 71688a8: Introduction of new themes: Clean, Muted, Bold, and Gradient
|
||||
- 1823101: Fix internal properties appearing in OpenAPI docs.
|
||||
- 6a073e1: Add antialiasing for text rendering
|
||||
- 8126a83: Improve readability of tables with hover style and vertical dividers
|
||||
- db74ea3: Image optimization endpoint redirects to underlying image URL if the signature is not the latest.
|
||||
- 99579ac: Fix a vulnerability issue for images using an older version of the image signing parameter.
|
||||
- e4e2f52: Track an event into site insights when visitor is opening the Scalar API client.
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- d876399: Fix UI search without ask AI enabled and fix error with questions not returned from API
|
||||
- c30bc24: Fix empty sitemap
|
||||
- e90c96f: page outline on the right remains visible when scrolling, move mode toggler to PageAside
|
||||
- 5b4e710: Support llms.txt
|
||||
- b6c3870: Add support for keyboard marks
|
||||
- 6059efe: Fix search no results error showing while there are results
|
||||
- c77142a: Log component stack in Sentry
|
||||
- 1de9d1a: Apply antialiasing on any text that are not code inline/blocks to avoid contrast issues
|
||||
- 32aa1f9: Handle security issue with cookies on Safari
|
||||
- d935fb1: Don't add extra page scroll when footer is not present
|
||||
- 53de5b1: Fix site section URL resolution in Ask AI sources
|
||||
- 24f5249: Fix vertical section overflow color
|
||||
- 1762f85: Reduce gap between subsequent header buttons
|
||||
- c1e27cc: Fix pass Sentry release properly
|
||||
- 5ae1b88: Fix shrinking page icons
|
||||
- 8f046a9: Start using tint in more places, TOC and PageAside
|
||||
- 665b6be: Ignore invalid API calls to `getSiteRedirectFromSource` API
|
||||
- d876399: Fix UI search without ask AI enabled and fix error with questions not returned from API
|
||||
- c30bc24: Fix empty sitemap
|
||||
- e90c96f: page outline on the right remains visible when scrolling, move mode toggler to PageAside
|
||||
- 5b4e710: Support llms.txt
|
||||
- b6c3870: Add support for keyboard marks
|
||||
- 6059efe: Fix search no results error showing while there are results
|
||||
- c77142a: Log component stack in Sentry
|
||||
- 1de9d1a: Apply antialiasing on any text that are not code inline/blocks to avoid contrast issues
|
||||
- 32aa1f9: Handle security issue with cookies on Safari
|
||||
- d935fb1: Don't add extra page scroll when footer is not present
|
||||
- 53de5b1: Fix site section URL resolution in Ask AI sources
|
||||
- 24f5249: Fix vertical section overflow color
|
||||
- 1762f85: Reduce gap between subsequent header buttons
|
||||
- c1e27cc: Fix pass Sentry release properly
|
||||
- 5ae1b88: Fix shrinking page icons
|
||||
- 8f046a9: Start using tint in more places, TOC and PageAside
|
||||
- 665b6be: Ignore invalid API calls to `getSiteRedirectFromSource` API
|
||||
|
||||
To reduce the load on the API and also avoid errors.
|
||||
To reduce the load on the API and also avoid errors.
|
||||
|
||||
- 26e6401: Remove KV cache backend and only rely on DO as an external cache backend
|
||||
- 8cfa67c: Fix default outline list styling
|
||||
- d66c184: Ignore errors from event flushing
|
||||
- 6088fa5: Simplify search results logic to investigate a bug
|
||||
- 68287d3: Cache API spec for 24 hours, revalidated every 2 hours
|
||||
- 09c7c30: Try to fix error on og image generation
|
||||
- ae99f87: Improve emoji setup, align with GitBook app
|
||||
- 2906e60: Downgrade to Next.js v14 to fix incompatibilities with next-on-pages causing multiple bugs.
|
||||
- 3a7210d: Fix zoom image view transition on Safari
|
||||
- 718a8a5: Position the variant picker in the ToC
|
||||
- e5dc05e: Update footer styling and allow for more than 4 footer groups
|
||||
- 8276ba0: Make cookies access safer
|
||||
- 1b8a456: Fix Image blocks zoomable behaviour
|
||||
- 56c52e0: Handle Firefox security error on localStorage
|
||||
- 0510b6f: Add section description to SectionGroupTile
|
||||
- 1fcc807: Fix errors from customization not found
|
||||
- 46edde9: Improve the OpenAPI package API
|
||||
- 8af1abc: Improve contrast of search box placeholder
|
||||
- 92b7668: Improve header offset
|
||||
- d9c8d57: Do not dereference before caching OpenAPI spec.
|
||||
- 94876e3: Fix regression issue with page icons for multi-line titles
|
||||
- 47971dc: Fix OG image generation for non-latin characters
|
||||
- 82dc9c4: Simplify the `useHash` algo used.
|
||||
- 128ad20: Ignore cache invalidation error from local backend
|
||||
- ff05e20: Improvements to inline images in headings
|
||||
- cb100d5: Allow only good values for theme query parameter. Avoid having a 500 error when we pass an invalid value.
|
||||
- d5aaccd: Remove use of deprecatd API createSitesPageFeedback
|
||||
- 48ab59f: Improve colour contrast of list item decoration
|
||||
- d2bc567: Set Sentry release
|
||||
- 37d13d8: Avoid error on fetch by passing a string URL
|
||||
- d3e573c: Generate sitemap for all sections and spaces
|
||||
- f7b801b: Add feedback form to page rating control
|
||||
- d370a3f: Update the routes for changes/revisions in multi-id mode to match the normal mode
|
||||
- 46f63cb: Fix code format overriding inline link styles
|
||||
- 5950657: Fix emojis display
|
||||
- 528a053: Fix server actions stability leading to no results found sometimes on search
|
||||
- eac1314: Lazy load iframely script to make page more responsive
|
||||
- ad19060: Cards stand out slighly more on tinted and dark mode sites, and have better support for headings inside them
|
||||
- 6f54826: New highlight colors
|
||||
- 5c87ec7: Implement a safer way to interact with localStorage.
|
||||
- 26e6401: Remove KV cache backend and only rely on DO as an external cache backend
|
||||
- 8cfa67c: Fix default outline list styling
|
||||
- d66c184: Ignore errors from event flushing
|
||||
- 6088fa5: Simplify search results logic to investigate a bug
|
||||
- 68287d3: Cache API spec for 24 hours, revalidated every 2 hours
|
||||
- 09c7c30: Try to fix error on og image generation
|
||||
- ae99f87: Improve emoji setup, align with GitBook app
|
||||
- 2906e60: Downgrade to Next.js v14 to fix incompatibilities with next-on-pages causing multiple bugs.
|
||||
- 3a7210d: Fix zoom image view transition on Safari
|
||||
- 718a8a5: Position the variant picker in the ToC
|
||||
- e5dc05e: Update footer styling and allow for more than 4 footer groups
|
||||
- 8276ba0: Make cookies access safer
|
||||
- 1b8a456: Fix Image blocks zoomable behaviour
|
||||
- 56c52e0: Handle Firefox security error on localStorage
|
||||
- 0510b6f: Add section description to SectionGroupTile
|
||||
- 1fcc807: Fix errors from customization not found
|
||||
- 46edde9: Improve the OpenAPI package API
|
||||
- 8af1abc: Improve contrast of search box placeholder
|
||||
- 92b7668: Improve header offset
|
||||
- d9c8d57: Do not dereference before caching OpenAPI spec.
|
||||
- 94876e3: Fix regression issue with page icons for multi-line titles
|
||||
- 47971dc: Fix OG image generation for non-latin characters
|
||||
- 82dc9c4: Simplify the `useHash` algo used.
|
||||
- 128ad20: Ignore cache invalidation error from local backend
|
||||
- ff05e20: Improvements to inline images in headings
|
||||
- cb100d5: Allow only good values for theme query parameter. Avoid having a 500 error when we pass an invalid value.
|
||||
- d5aaccd: Remove use of deprecatd API createSitesPageFeedback
|
||||
- 48ab59f: Improve colour contrast of list item decoration
|
||||
- d2bc567: Set Sentry release
|
||||
- 37d13d8: Avoid error on fetch by passing a string URL
|
||||
- d3e573c: Generate sitemap for all sections and spaces
|
||||
- f7b801b: Add feedback form to page rating control
|
||||
- d370a3f: Update the routes for changes/revisions in multi-id mode to match the normal mode
|
||||
- 46f63cb: Fix code format overriding inline link styles
|
||||
- 5950657: Fix emojis display
|
||||
- 528a053: Fix server actions stability leading to no results found sometimes on search
|
||||
- eac1314: Lazy load iframely script to make page more responsive
|
||||
- ad19060: Cards stand out slighly more on tinted and dark mode sites, and have better support for headings inside them
|
||||
- 6f54826: New highlight colors
|
||||
- 5c87ec7: Implement a safer way to interact with localStorage.
|
||||
|
||||
If it's disabled on the browser it should not throw error.
|
||||
If it's disabled on the browser it should not throw error.
|
||||
|
||||
- 02d876e: Fix search UI behaviour
|
||||
- f4a90de: Fix two issues where pages would crash due Recoil not behaving correctly in RSC.
|
||||
- 5576906: Fix table of content displaying arrow next to page with only hidden pages
|
||||
- aaab157: Visual fix for section group in Safari
|
||||
- cbe6139: Fix dynamic tabs infinite loop
|
||||
- 65cc4af: Fix error when accessing a change request not found
|
||||
- 727bde2: Improve and split OpenAPI parser into its own package
|
||||
- 0b6ddca: Fix variant selector contrast for non-default themes
|
||||
- 87b8ea8: Fix issue leading to increase the storage write and the stability of the platform
|
||||
- fde32e2: Force route handler to be dynamic to avoid errors
|
||||
- a025118: Change card layout depending on cover aspect ratio
|
||||
- 300f7bf: Fix search loading state
|
||||
- 29d5979: Disable C/C++ highlight temporarily
|
||||
- 18953b2: Subtler tint color when based on the primary color, by mixing in some gray
|
||||
- 1c97536: Fix Sentry instrumentation
|
||||
- b0bd871: Even safer localStorage
|
||||
- b950a64: Avoid errors on legacy browsers
|
||||
- 38061bd: Add section groups to section tabs
|
||||
- 160fca1: Support deprecated and x-deprecated-sunset in OpenAPI spec
|
||||
- 0e601e2: Improve styling of header buttons with shadows and high-contrast styles
|
||||
- 6691492: Fix viewing PDF from space
|
||||
- e8e64bf: Fix bullet list display on full size blocks
|
||||
- 16194c5: Vertical orientation for sections list on sites without header
|
||||
- b41d425: Improve OpenAPI rendering performances by caching markdown parsing
|
||||
- 1f8e416: Improve performances by highlighting code client-side if the code block is offscreen
|
||||
- 1429384: Fix error when accessing some not found pages.
|
||||
- 21cbd9e: Change link color to primary-subtle
|
||||
- 5dab70f: Fix "Parser" language syntax highlighting
|
||||
- deb8c54: Upgrade Next.js to v15, upgrade Shiki and use JS RegExp engine
|
||||
- 56331d2: Fix breadcrumbs emoji display + add contrast styles
|
||||
- a6f6591: Fix server actions cache compromised. Leading to some bugs on frontend.
|
||||
- 44a20fe: Improve smoothness of scroll listener
|
||||
- 5664e5a: Fix variant dropdown styling in header
|
||||
- 6b50360: Fix view transition error on Safari
|
||||
- 741dd49: Bump `heading-3` font size to offset it from paragraphs
|
||||
- 5112e3e: Fix Sentry instrumentation server-side
|
||||
- 1de338c: Remove animation on section tabs. Page is reloaded (for technical reasons), so the animation is not accurate here.
|
||||
- Updated dependencies [d9029c7]
|
||||
- Updated dependencies [6e54a06]
|
||||
- Updated dependencies [162b4b7]
|
||||
- Updated dependencies [e4e2f52]
|
||||
- Updated dependencies [0c03676]
|
||||
- Updated dependencies [3e5e458]
|
||||
- Updated dependencies [46edde9]
|
||||
- Updated dependencies [d9c8d57]
|
||||
- Updated dependencies [ccf2cff]
|
||||
- Updated dependencies [dda0cc6]
|
||||
- Updated dependencies [eb7c22f]
|
||||
- Updated dependencies [ea1468c]
|
||||
- Updated dependencies [648f0e9]
|
||||
- Updated dependencies [160fca1]
|
||||
- Updated dependencies [f92e906]
|
||||
- Updated dependencies [e721f17]
|
||||
- Updated dependencies [727bde2]
|
||||
- Updated dependencies [dff08ae]
|
||||
- Updated dependencies [fc7b16f]
|
||||
- Updated dependencies [fe8acc9]
|
||||
- Updated dependencies [1823101]
|
||||
- Updated dependencies [a652958]
|
||||
- Updated dependencies [2f73db7]
|
||||
- Updated dependencies [160fca1]
|
||||
- Updated dependencies [12c7862]
|
||||
- Updated dependencies [b41d425]
|
||||
- @gitbook/react-openapi@1.0.0
|
||||
- @gitbook/openapi-parser@1.0.0
|
||||
- @gitbook/react-contentkit@0.6.0
|
||||
- 02d876e: Fix search UI behaviour
|
||||
- f4a90de: Fix two issues where pages would crash due Recoil not behaving correctly in RSC.
|
||||
- 5576906: Fix table of content displaying arrow next to page with only hidden pages
|
||||
- aaab157: Visual fix for section group in Safari
|
||||
- cbe6139: Fix dynamic tabs infinite loop
|
||||
- 65cc4af: Fix error when accessing a change request not found
|
||||
- 727bde2: Improve and split OpenAPI parser into its own package
|
||||
- 0b6ddca: Fix variant selector contrast for non-default themes
|
||||
- 87b8ea8: Fix issue leading to increase the storage write and the stability of the platform
|
||||
- fde32e2: Force route handler to be dynamic to avoid errors
|
||||
- a025118: Change card layout depending on cover aspect ratio
|
||||
- 300f7bf: Fix search loading state
|
||||
- 29d5979: Disable C/C++ highlight temporarily
|
||||
- 18953b2: Subtler tint color when based on the primary color, by mixing in some gray
|
||||
- 1c97536: Fix Sentry instrumentation
|
||||
- b0bd871: Even safer localStorage
|
||||
- b950a64: Avoid errors on legacy browsers
|
||||
- 38061bd: Add section groups to section tabs
|
||||
- 160fca1: Support deprecated and x-deprecated-sunset in OpenAPI spec
|
||||
- 0e601e2: Improve styling of header buttons with shadows and high-contrast styles
|
||||
- 6691492: Fix viewing PDF from space
|
||||
- e8e64bf: Fix bullet list display on full size blocks
|
||||
- 16194c5: Vertical orientation for sections list on sites without header
|
||||
- b41d425: Improve OpenAPI rendering performances by caching markdown parsing
|
||||
- 1f8e416: Improve performances by highlighting code client-side if the code block is offscreen
|
||||
- 1429384: Fix error when accessing some not found pages.
|
||||
- 21cbd9e: Change link color to primary-subtle
|
||||
- 5dab70f: Fix "Parser" language syntax highlighting
|
||||
- deb8c54: Upgrade Next.js to v15, upgrade Shiki and use JS RegExp engine
|
||||
- 56331d2: Fix breadcrumbs emoji display + add contrast styles
|
||||
- a6f6591: Fix server actions cache compromised. Leading to some bugs on frontend.
|
||||
- 44a20fe: Improve smoothness of scroll listener
|
||||
- 5664e5a: Fix variant dropdown styling in header
|
||||
- 6b50360: Fix view transition error on Safari
|
||||
- 741dd49: Bump `heading-3` font size to offset it from paragraphs
|
||||
- 5112e3e: Fix Sentry instrumentation server-side
|
||||
- 1de338c: Remove animation on section tabs. Page is reloaded (for technical reasons), so the animation is not accurate here.
|
||||
- Updated dependencies [d9029c7]
|
||||
- Updated dependencies [6e54a06]
|
||||
- Updated dependencies [162b4b7]
|
||||
- Updated dependencies [e4e2f52]
|
||||
- Updated dependencies [0c03676]
|
||||
- Updated dependencies [3e5e458]
|
||||
- Updated dependencies [46edde9]
|
||||
- Updated dependencies [d9c8d57]
|
||||
- Updated dependencies [ccf2cff]
|
||||
- Updated dependencies [dda0cc6]
|
||||
- Updated dependencies [eb7c22f]
|
||||
- Updated dependencies [ea1468c]
|
||||
- Updated dependencies [648f0e9]
|
||||
- Updated dependencies [160fca1]
|
||||
- Updated dependencies [f92e906]
|
||||
- Updated dependencies [e721f17]
|
||||
- Updated dependencies [727bde2]
|
||||
- Updated dependencies [dff08ae]
|
||||
- Updated dependencies [fc7b16f]
|
||||
- Updated dependencies [fe8acc9]
|
||||
- Updated dependencies [1823101]
|
||||
- Updated dependencies [a652958]
|
||||
- Updated dependencies [2f73db7]
|
||||
- Updated dependencies [160fca1]
|
||||
- Updated dependencies [12c7862]
|
||||
- Updated dependencies [b41d425]
|
||||
- @gitbook/react-openapi@1.0.0
|
||||
- @gitbook/openapi-parser@1.0.0
|
||||
- @gitbook/react-contentkit@0.6.0
|
||||
|
||||
## 0.5.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- 57cdd25: GitBook Open now supports Ask AI in sites. When asking a question to Ask AI, GitBook will use context from across your site sections and variants to provide the best answer.
|
||||
- ca134c8: Fix an issue where the active site section indicator appeared above any dropdowns.
|
||||
- d48926e: Fix an issue where the space dropdown was shown under the site sections in Safari.
|
||||
- 9fe8142: Fix an issue where Ask AI was erroring due to an object being passed as a param.
|
||||
- d843e5e: Fix an issue where the space dropdown could appear behind the header.
|
||||
- a2e5647: Fix the styling of site section tabs on smaller screens.
|
||||
- 57cdd25: GitBook Open now supports Ask AI in sites. When asking a question to Ask AI, GitBook will use context from across your site sections and variants to provide the best answer.
|
||||
- ca134c8: Fix an issue where the active site section indicator appeared above any dropdowns.
|
||||
- d48926e: Fix an issue where the space dropdown was shown under the site sections in Safari.
|
||||
- 9fe8142: Fix an issue where Ask AI was erroring due to an object being passed as a param.
|
||||
- d843e5e: Fix an issue where the space dropdown could appear behind the header.
|
||||
- a2e5647: Fix the styling of site section tabs on smaller screens.
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 076dc48: Fix expandable block anchore resolution
|
||||
- d9bb9f9: Fix an issue with the cookie banner buttons being non responsive
|
||||
- 23584c9: Update the site header with new styling, a new search button, and refactored layout
|
||||
- 664debc: Add support for tint color
|
||||
- 4d56f11: Update styling of search+ask modal
|
||||
- 061c0c1: Fix a regression in variant drop-down caused by missing z-index.
|
||||
- 2f76712: Add breadcrumbs above page title
|
||||
- 07cf835: Add scroll margin to the top when there are sections
|
||||
- 5d72b35: Smoother tab transition for sections
|
||||
- 7c71363: Don't adjust fallback font for mono font.
|
||||
- 7675c2c: Optimize performances by using new API endpoint for fetching site data.
|
||||
- 87eea73: Fix margin and image resolution of header logo
|
||||
- aa2ed0f: Restyle hint blocks
|
||||
- ffd3937: Fix security issue with image resizing that could be used for phishing
|
||||
- 2ce59d7: Fix - whitespace added to site section tabs with icons.
|
||||
- c73e07d: Increase token max length to fix code not highlighted
|
||||
- 3b3d6e2: Add icons to sections
|
||||
- 1ed18c0: style: adds missing scalar css variables
|
||||
- Updated dependencies [b7a5106]
|
||||
- Updated dependencies [4771c78]
|
||||
- Updated dependencies [ff50ac2]
|
||||
- Updated dependencies [867481c]
|
||||
- Updated dependencies [7ba67fd]
|
||||
- Updated dependencies [a78c1ec]
|
||||
- @gitbook/cache-do@0.1.1
|
||||
- @gitbook/react-openapi@0.7.1
|
||||
- 076dc48: Fix expandable block anchore resolution
|
||||
- d9bb9f9: Fix an issue with the cookie banner buttons being non responsive
|
||||
- 23584c9: Update the site header with new styling, a new search button, and refactored layout
|
||||
- 664debc: Add support for tint color
|
||||
- 4d56f11: Update styling of search+ask modal
|
||||
- 061c0c1: Fix a regression in variant drop-down caused by missing z-index.
|
||||
- 2f76712: Add breadcrumbs above page title
|
||||
- 07cf835: Add scroll margin to the top when there are sections
|
||||
- 5d72b35: Smoother tab transition for sections
|
||||
- 7c71363: Don't adjust fallback font for mono font.
|
||||
- 7675c2c: Optimize performances by using new API endpoint for fetching site data.
|
||||
- 87eea73: Fix margin and image resolution of header logo
|
||||
- aa2ed0f: Restyle hint blocks
|
||||
- ffd3937: Fix security issue with image resizing that could be used for phishing
|
||||
- 2ce59d7: Fix - whitespace added to site section tabs with icons.
|
||||
- c73e07d: Increase token max length to fix code not highlighted
|
||||
- 3b3d6e2: Add icons to sections
|
||||
- 1ed18c0: style: adds missing scalar css variables
|
||||
- Updated dependencies [b7a5106]
|
||||
- Updated dependencies [4771c78]
|
||||
- Updated dependencies [ff50ac2]
|
||||
- Updated dependencies [867481c]
|
||||
- Updated dependencies [7ba67fd]
|
||||
- Updated dependencies [a78c1ec]
|
||||
- @gitbook/cache-do@0.1.1
|
||||
- @gitbook/react-openapi@0.7.1
|
||||
|
||||
## 0.4.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- e09f747: Revalidate change request cached content when pressing refresh button
|
||||
- 2fa0851: Add navigation tabs for sections
|
||||
- a4b63b8: Support resolution of new site URLs with sections
|
||||
- 5c35f36: Replace all icons, previously imported from Geist, by new package `@gitbook/icons`
|
||||
- e9b31a5: Unify section tab styles with page item styles
|
||||
- f12a215: Add support for Norwegian language
|
||||
- f4c9536: Optimize layout shift while transitioning between pages with full width blocks (ex: OpenAPI blocks)
|
||||
- 1f24fe4: Add support for page icons
|
||||
- cda08a9: Add support for searching results in a sections site
|
||||
- b32e40c: Persist state of tabs and dynamically sync them based on title
|
||||
- 15d2ee3: Show the caption for file blocks
|
||||
- f885e88: Improve the toolbar for change-requests and revisions to show more actions
|
||||
- 07ea45b: Remove deprecated synced block from GitBook Open
|
||||
- c3675fd: Added support for new Reusable Content block.
|
||||
- 1f24fe4: Add support for icons style customization for sites
|
||||
- 4c19014: Prevent search indexation for pages where it's configured as disabled
|
||||
- 3422ad4: Update rendering of community ads to match new API response, and make it possible to preview ads.
|
||||
- 1152445: Changed the alternative URL resolution criteria in order to support site URLs without /v/ prefix
|
||||
- 2c437f7: Fix linking to a tab itself
|
||||
- e09f747: Revalidate change request cached content when pressing refresh button
|
||||
- 2fa0851: Add navigation tabs for sections
|
||||
- a4b63b8: Support resolution of new site URLs with sections
|
||||
- 5c35f36: Replace all icons, previously imported from Geist, by new package `@gitbook/icons`
|
||||
- e9b31a5: Unify section tab styles with page item styles
|
||||
- f12a215: Add support for Norwegian language
|
||||
- f4c9536: Optimize layout shift while transitioning between pages with full width blocks (ex: OpenAPI blocks)
|
||||
- 1f24fe4: Add support for page icons
|
||||
- cda08a9: Add support for searching results in a sections site
|
||||
- b32e40c: Persist state of tabs and dynamically sync them based on title
|
||||
- 15d2ee3: Show the caption for file blocks
|
||||
- f885e88: Improve the toolbar for change-requests and revisions to show more actions
|
||||
- 07ea45b: Remove deprecated synced block from GitBook Open
|
||||
- c3675fd: Added support for new Reusable Content block.
|
||||
- 1f24fe4: Add support for icons style customization for sites
|
||||
- 4c19014: Prevent search indexation for pages where it's configured as disabled
|
||||
- 3422ad4: Update rendering of community ads to match new API response, and make it possible to preview ads.
|
||||
- 1152445: Changed the alternative URL resolution criteria in order to support site URLs without /v/ prefix
|
||||
- 2c437f7: Fix linking to a tab itself
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- aa32198: Avoid multiple <h1> in the page by using a <div> for the title in the header
|
||||
- 51fa3ab: Adds content-visibility css property to OpenAPI Operation for better render performance
|
||||
- a7066cc: Fix scroll position when navigating pages on mobile
|
||||
- c754fc9: Add automatic color contrast in site header, restyle search button
|
||||
- 5fe7adb: RND-3532: drop down menu for hidden links at small screen size
|
||||
- 6295881: Change dark mode shadow for multi-space search toolbar
|
||||
- f89b31c: Upgrade the scalar api client package
|
||||
- 13c7534: Use ellipsis and fix icon color for more links in the header on small screen
|
||||
- f885e88: Improve consistency of change request preview by removing cache-control on response
|
||||
- 16e6171: Improve performances of loading pages with embeds by caching them
|
||||
- 34d36c6: Fix GitBook specific static assets not being served correctly when deployed on Cloudflare
|
||||
- af9e66e: Only display spaces dropdown in compact header when site is multi-variants
|
||||
- e3a3d6a: Improve perception of fast loading by not rendering skeletons for individual blocks in the top part of the viewport
|
||||
- 042b850: Automatically scroll to active item in TOC
|
||||
- d43202f: Optimize bundle size of the server output by reducing bundle size of shiki (skipping themes)
|
||||
- bfbed1a: Ensure "Sponsored via GitBook" can be translated in all languages
|
||||
- fe9e6c1: Update ogimage with new design
|
||||
- 17f71ba: Use url hash to open Expandable and scroll to anchor
|
||||
- 3c07e65: Fix margin for paragraphs in quote blocks
|
||||
- 636b868: Use new cache backend, powered by Durable Objects, alongside the existing ones (KV, etc).
|
||||
- f16560c: Include offset in calculations of whether scrollable element is in view
|
||||
- 689f553: Fix inconsistent click area in table because of scroll indicator
|
||||
- 6ce3cea: Stop using KV cache backend for now, but also improves it for higher performances
|
||||
- e914903: Synchronize response and response example tabs
|
||||
- 0f990c7: Show definition title when visible in cards
|
||||
- e3a3d6a: Fix flickering when displaying an "Ask" answer with code blocks
|
||||
- 4cbcc5b: Rollback of scalar modal while fixing perf issue
|
||||
- 3996110: Optimize images rendered in community ads
|
||||
- 133c3e7: Update design of Checkbox to be more consistent and readable
|
||||
- 5096f7f: Disable KV cache for docs.gitbook.com as a test, also disable it for change-request to improve consistency
|
||||
- 0f1565c: Add optional env `GITBOOK_INTEGRATIONS_HOST` to configure the host serving the integrations
|
||||
- 2ff7ed1: Fix table of contents being visible on mobile when disabled at the page level
|
||||
- b075f0f: Fix accessibility of the table of contents by using `aria-current` instead of `aria-selected`
|
||||
- cb782a7: Fix "ip" being passed to BSA for community ads
|
||||
- a7af3ca: Improving the look and feel of new section tabs
|
||||
- 0bf985a: Don't show hidden pages in the empty state of a page
|
||||
- d6c28a0: Update header styling of sections, variant selector, and button links
|
||||
- aa32198: Avoid multiple <h1> in the page by using a <div> for the title in the header
|
||||
- 51fa3ab: Adds content-visibility css property to OpenAPI Operation for better render performance
|
||||
- a7066cc: Fix scroll position when navigating pages on mobile
|
||||
- c754fc9: Add automatic color contrast in site header, restyle search button
|
||||
- 5fe7adb: RND-3532: drop down menu for hidden links at small screen size
|
||||
- 6295881: Change dark mode shadow for multi-space search toolbar
|
||||
- f89b31c: Upgrade the scalar api client package
|
||||
- 13c7534: Use ellipsis and fix icon color for more links in the header on small screen
|
||||
- f885e88: Improve consistency of change request preview by removing cache-control on response
|
||||
- 16e6171: Improve performances of loading pages with embeds by caching them
|
||||
- 34d36c6: Fix GitBook specific static assets not being served correctly when deployed on Cloudflare
|
||||
- af9e66e: Only display spaces dropdown in compact header when site is multi-variants
|
||||
- e3a3d6a: Improve perception of fast loading by not rendering skeletons for individual blocks in the top part of the viewport
|
||||
- 042b850: Automatically scroll to active item in TOC
|
||||
- d43202f: Optimize bundle size of the server output by reducing bundle size of shiki (skipping themes)
|
||||
- bfbed1a: Ensure "Sponsored via GitBook" can be translated in all languages
|
||||
- fe9e6c1: Update ogimage with new design
|
||||
- 17f71ba: Use url hash to open Expandable and scroll to anchor
|
||||
- 3c07e65: Fix margin for paragraphs in quote blocks
|
||||
- 636b868: Use new cache backend, powered by Durable Objects, alongside the existing ones (KV, etc).
|
||||
- f16560c: Include offset in calculations of whether scrollable element is in view
|
||||
- 689f553: Fix inconsistent click area in table because of scroll indicator
|
||||
- 6ce3cea: Stop using KV cache backend for now, but also improves it for higher performances
|
||||
- e914903: Synchronize response and response example tabs
|
||||
- 0f990c7: Show definition title when visible in cards
|
||||
- e3a3d6a: Fix flickering when displaying an "Ask" answer with code blocks
|
||||
- 4cbcc5b: Rollback of scalar modal while fixing perf issue
|
||||
- 3996110: Optimize images rendered in community ads
|
||||
- 133c3e7: Update design of Checkbox to be more consistent and readable
|
||||
- 5096f7f: Disable KV cache for docs.gitbook.com as a test, also disable it for change-request to improve consistency
|
||||
- 0f1565c: Add optional env `GITBOOK_INTEGRATIONS_HOST` to configure the host serving the integrations
|
||||
- 2ff7ed1: Fix table of contents being visible on mobile when disabled at the page level
|
||||
- b075f0f: Fix accessibility of the table of contents by using `aria-current` instead of `aria-selected`
|
||||
- cb782a7: Fix "ip" being passed to BSA for community ads
|
||||
- a7af3ca: Improving the look and feel of new section tabs
|
||||
- 0bf985a: Don't show hidden pages in the empty state of a page
|
||||
- d6c28a0: Update header styling of sections, variant selector, and button links
|
||||
|
||||
- Change position of variant selector depending on context (next to logo or in table of contents)
|
||||
- Update section tab styling and animation
|
||||
- Make header buttons smaller with a new `medium` button size
|
||||
- Change position of variant selector depending on context (next to logo or in table of contents)
|
||||
- Update section tab styling and animation
|
||||
- Make header buttons smaller with a new `medium` button size
|
||||
|
||||
- Updated dependencies [51fa3ab]
|
||||
- Updated dependencies [9b8d519]
|
||||
- Updated dependencies [cf3045a]
|
||||
- Updated dependencies [f89b31c]
|
||||
- Updated dependencies [d0f4860]
|
||||
- Updated dependencies [ef9d012]
|
||||
- Updated dependencies [094e9cd]
|
||||
- Updated dependencies [636b868]
|
||||
- Updated dependencies [56f5fa1]
|
||||
- Updated dependencies [5c35f36]
|
||||
- Updated dependencies [4247361]
|
||||
- Updated dependencies [aa8c49e]
|
||||
- Updated dependencies [e914903]
|
||||
- Updated dependencies [4cbcc5b]
|
||||
- Updated dependencies [0f1565c]
|
||||
- Updated dependencies [237b703]
|
||||
- Updated dependencies [51955da]
|
||||
- Updated dependencies [a679e72]
|
||||
- Updated dependencies [c079c3c]
|
||||
- Updated dependencies [5c35f36]
|
||||
- Updated dependencies [776bc31]
|
||||
- @gitbook/react-openapi@0.7.0
|
||||
- @gitbook/cache-do@0.1.0
|
||||
- @gitbook/icons@0.1.0
|
||||
- @gitbook/react-contentkit@0.5.1
|
||||
- @gitbook/react-math@0.6.0
|
||||
- Updated dependencies [51fa3ab]
|
||||
- Updated dependencies [9b8d519]
|
||||
- Updated dependencies [cf3045a]
|
||||
- Updated dependencies [f89b31c]
|
||||
- Updated dependencies [d0f4860]
|
||||
- Updated dependencies [ef9d012]
|
||||
- Updated dependencies [094e9cd]
|
||||
- Updated dependencies [636b868]
|
||||
- Updated dependencies [56f5fa1]
|
||||
- Updated dependencies [5c35f36]
|
||||
- Updated dependencies [4247361]
|
||||
- Updated dependencies [aa8c49e]
|
||||
- Updated dependencies [e914903]
|
||||
- Updated dependencies [4cbcc5b]
|
||||
- Updated dependencies [0f1565c]
|
||||
- Updated dependencies [237b703]
|
||||
- Updated dependencies [51955da]
|
||||
- Updated dependencies [a679e72]
|
||||
- Updated dependencies [c079c3c]
|
||||
- Updated dependencies [5c35f36]
|
||||
- Updated dependencies [776bc31]
|
||||
- @gitbook/react-openapi@0.7.0
|
||||
- @gitbook/cache-do@0.1.0
|
||||
- @gitbook/icons@0.1.0
|
||||
- @gitbook/react-contentkit@0.5.1
|
||||
- @gitbook/react-math@0.6.0
|
||||
|
||||
## 0.3.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- 24b785c: Update shiki for code block syntax highlighting, with support for more languages and fixes for diffs. It also patches the deployment on Cloudflare to support edge functions larger than 4MB.
|
||||
- 24b785c: Update shiki for code block syntax highlighting, with support for more languages and fixes for diffs. It also patches the deployment on Cloudflare to support edge functions larger than 4MB.
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- acc3f2f: Fix error with the "Try it" of OpenAPI block because of the Scalar proxy failing on Cloudflare with the `cache` option
|
||||
- Updated dependencies [709f1a1]
|
||||
- Updated dependencies [ede2335]
|
||||
- Updated dependencies [0426312]
|
||||
- @gitbook/react-openapi@0.6.0
|
||||
- acc3f2f: Fix error with the "Try it" of OpenAPI block because of the Scalar proxy failing on Cloudflare with the `cache` option
|
||||
- Updated dependencies [709f1a1]
|
||||
- Updated dependencies [ede2335]
|
||||
- Updated dependencies [0426312]
|
||||
- @gitbook/react-openapi@0.6.0
|
||||
|
||||
## 0.2.2
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [3445db4]
|
||||
- @gitbook/react-contentkit@0.5.0
|
||||
- @gitbook/react-openapi@0.5.0
|
||||
- @gitbook/react-math@0.5.0
|
||||
- Updated dependencies [3445db4]
|
||||
- @gitbook/react-contentkit@0.5.0
|
||||
- @gitbook/react-openapi@0.5.0
|
||||
- @gitbook/react-math@0.5.0
|
||||
|
||||
## 0.2.1
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [24cd72e]
|
||||
- @gitbook/react-contentkit@0.4.0
|
||||
- @gitbook/react-math@0.4.0
|
||||
- @gitbook/react-openapi@0.4.0
|
||||
- Updated dependencies [24cd72e]
|
||||
- @gitbook/react-contentkit@0.4.0
|
||||
- @gitbook/react-math@0.4.0
|
||||
- @gitbook/react-openapi@0.4.0
|
||||
|
||||
## 0.2.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- de747b7: Refactor the repository to be a proper monorepo and publish JS files on NPM instead of TypeScript files.
|
||||
- de747b7: Refactor the repository to be a proper monorepo and publish JS files on NPM instead of TypeScript files.
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [de747b7]
|
||||
- Updated dependencies [de747b7]
|
||||
- @gitbook/react-contentkit@0.3.0
|
||||
- @gitbook/react-openapi@0.3.0
|
||||
- @gitbook/react-math@0.3.0
|
||||
- Updated dependencies [de747b7]
|
||||
- Updated dependencies [de747b7]
|
||||
- @gitbook/react-contentkit@0.3.0
|
||||
- @gitbook/react-openapi@0.3.0
|
||||
- @gitbook/react-math@0.3.0
|
||||
|
||||
@@ -19,6 +19,7 @@ import {
|
||||
type TestsCase,
|
||||
allDeprecatedThemePresets,
|
||||
allLocales,
|
||||
allSearchStyles,
|
||||
allSidebarBackgroundStyles,
|
||||
allThemeModes,
|
||||
allThemes,
|
||||
@@ -647,6 +648,23 @@ const testCases: TestsCase[] = [
|
||||
run: waitForCookiesDialog,
|
||||
})),
|
||||
]),
|
||||
...allSearchStyles.flatMap((searchStyle) => ({
|
||||
name: `Theme ${theme} – Search ${searchStyle} – Mode ${themeMode}`,
|
||||
url: getCustomizationURL({
|
||||
styling: {
|
||||
theme,
|
||||
search: searchStyle,
|
||||
},
|
||||
header: {
|
||||
links: headerLinks,
|
||||
},
|
||||
themes: {
|
||||
default: themeMode,
|
||||
toggeable: false,
|
||||
},
|
||||
}),
|
||||
run: waitForCookiesDialog,
|
||||
})),
|
||||
]),
|
||||
// Deprecated header themes
|
||||
...allDeprecatedThemePresets.flatMap((preset) => [
|
||||
|
||||
@@ -8,6 +8,7 @@ import {
|
||||
CustomizationIconsStyle,
|
||||
CustomizationLinksStyle,
|
||||
CustomizationLocale,
|
||||
CustomizationSearchStyle,
|
||||
CustomizationSidebarBackgroundStyle,
|
||||
CustomizationSidebarListStyle,
|
||||
CustomizationTheme,
|
||||
@@ -109,6 +110,11 @@ export const allSidebarBackgroundStyles: CustomizationSidebarBackgroundStyle[] =
|
||||
CustomizationSidebarBackgroundStyle.Filled,
|
||||
];
|
||||
|
||||
export const allSearchStyles: CustomizationSearchStyle[] = [
|
||||
CustomizationSearchStyle.Prominent,
|
||||
CustomizationSearchStyle.Subtle,
|
||||
];
|
||||
|
||||
// Common customization settings
|
||||
|
||||
export const headerLinks: CustomizationHeaderItem[] = [
|
||||
@@ -257,6 +263,7 @@ export function getCustomizationURL(partial: DeepPartial<SiteCustomizationSettin
|
||||
background: CustomizationSidebarBackgroundStyle.Default,
|
||||
list: CustomizationSidebarListStyle.Default,
|
||||
},
|
||||
search: CustomizationSearchStyle.Subtle,
|
||||
},
|
||||
internationalization: {
|
||||
locale: CustomizationLocale.En,
|
||||
|
||||
@@ -1,83 +1,49 @@
|
||||
const { withSentryConfig } = require('@sentry/nextjs');
|
||||
|
||||
module.exports = withSentryConfig(
|
||||
{
|
||||
env: {
|
||||
BUILD_VERSION: (process.env.GITHUB_SHA ?? '').slice(0, 7),
|
||||
SENTRY_RELEASE: process.env.SENTRY_RELEASE ?? '',
|
||||
SENTRY_DSN: process.env.SENTRY_DSN ?? '',
|
||||
SENTRY_ENVIRONMENT: process.env.SENTRY_ENVIRONMENT ?? 'development',
|
||||
GITBOOK_ASSETS_PREFIX: process.env.GITBOOK_ASSETS_PREFIX,
|
||||
GITBOOK_ICONS_URL: process.env.GITBOOK_ICONS_URL,
|
||||
GITBOOK_ICONS_TOKEN: process.env.GITBOOK_ICONS_TOKEN,
|
||||
NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: process.env.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY,
|
||||
},
|
||||
|
||||
webpack(config, { dev, webpack }) {
|
||||
config.resolve.fallback = {
|
||||
...config.resolve.fallback,
|
||||
|
||||
// Required for `swagger2openapi` to work:
|
||||
fs: false,
|
||||
path: false,
|
||||
http: false,
|
||||
};
|
||||
|
||||
// Tree shake debug code for Sentry
|
||||
// https://docs.sentry.io/platforms/javascript/guides/nextjs/configuration/tree-shaking/#tree-shaking-with-nextjs
|
||||
if (!dev) {
|
||||
config.plugins.push(
|
||||
new webpack.DefinePlugin({
|
||||
__SENTRY_DEBUG__: false,
|
||||
// We always init Sentry with enableTracing: false for now, so this is useless
|
||||
__SENTRY_TRACING__: false,
|
||||
__RRWEB_EXCLUDE_IFRAME__: true,
|
||||
__RRWEB_EXCLUDE_SHADOW_DOM__: true,
|
||||
__SENTRY_EXCLUDE_REPLAY_WORKER__: true,
|
||||
})
|
||||
);
|
||||
}
|
||||
|
||||
return config;
|
||||
},
|
||||
|
||||
async headers() {
|
||||
return [
|
||||
// Cache all static assets for 1 year
|
||||
{
|
||||
source: '/~gitbook/static/:path*',
|
||||
headers: [
|
||||
{
|
||||
key: 'Cache-Control',
|
||||
value: 'public, max-age=31536000, immutable',
|
||||
},
|
||||
],
|
||||
},
|
||||
];
|
||||
},
|
||||
|
||||
assetPrefix: process.env.GITBOOK_ASSETS_PREFIX,
|
||||
poweredByHeader: false,
|
||||
|
||||
images: {
|
||||
remotePatterns: [
|
||||
{
|
||||
protocol: 'https',
|
||||
hostname: '*.gitbook.io',
|
||||
},
|
||||
],
|
||||
},
|
||||
module.exports = {
|
||||
env: {
|
||||
BUILD_VERSION: (process.env.GITHUB_SHA ?? '').slice(0, 7),
|
||||
GITBOOK_ASSETS_PREFIX: process.env.GITBOOK_ASSETS_PREFIX,
|
||||
GITBOOK_ICONS_URL: process.env.GITBOOK_ICONS_URL,
|
||||
GITBOOK_ICONS_TOKEN: process.env.GITBOOK_ICONS_TOKEN,
|
||||
NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: process.env.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY,
|
||||
},
|
||||
{
|
||||
release: process.env.SENTRY_RELEASE,
|
||||
org: process.env.SENTRY_ORG,
|
||||
project: process.env.SENTRY_PROJECT,
|
||||
authToken: process.env.SENTRY_AUTH_TOKEN,
|
||||
|
||||
// Upload a larger set of source maps for prettier stack traces (increases build time)
|
||||
widenClientFileUpload: true,
|
||||
// Routes browser requests to Sentry through a Next.js rewrite to circumvent ad-blockers (increases server load)
|
||||
tunnelRoute: '/~gitbook/monitoring',
|
||||
disableLogger: true,
|
||||
}
|
||||
);
|
||||
webpack(config) {
|
||||
config.resolve.fallback = {
|
||||
...config.resolve.fallback,
|
||||
|
||||
// Required for `swagger2openapi` to work:
|
||||
fs: false,
|
||||
path: false,
|
||||
http: false,
|
||||
};
|
||||
|
||||
return config;
|
||||
},
|
||||
|
||||
async headers() {
|
||||
return [
|
||||
// Cache all static assets for 1 year
|
||||
{
|
||||
source: '/~gitbook/static/:path*',
|
||||
headers: [
|
||||
{
|
||||
key: 'Cache-Control',
|
||||
value: 'public, max-age=31536000, immutable',
|
||||
},
|
||||
],
|
||||
},
|
||||
];
|
||||
},
|
||||
|
||||
assetPrefix: process.env.GITBOOK_ASSETS_PREFIX,
|
||||
poweredByHeader: false,
|
||||
|
||||
images: {
|
||||
remotePatterns: [
|
||||
{
|
||||
protocol: 'https',
|
||||
hostname: '*.gitbook.io',
|
||||
},
|
||||
],
|
||||
},
|
||||
};
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "gitbook",
|
||||
"version": "0.7.3",
|
||||
"version": "0.8.1",
|
||||
"private": true,
|
||||
"scripts": {
|
||||
"dev": "env-cmd --silent -f ../../.env.local next dev",
|
||||
@@ -29,7 +29,6 @@
|
||||
"@radix-ui/react-checkbox": "^1.0.4",
|
||||
"@radix-ui/react-navigation-menu": "^1.2.3",
|
||||
"@radix-ui/react-popover": "^1.0.7",
|
||||
"@sentry/nextjs": "8.35.0",
|
||||
"@sindresorhus/fnv1a": "^3.1.0",
|
||||
"@tailwindcss/container-queries": "^0.1.1",
|
||||
"@tailwindcss/typography": "^0.5.16",
|
||||
|
||||
@@ -1,18 +0,0 @@
|
||||
import * as Sentry from '@sentry/browser';
|
||||
|
||||
const dsn = process.env.SENTRY_DSN;
|
||||
if (dsn) {
|
||||
Sentry.init({
|
||||
dsn,
|
||||
release: process.env.SENTRY_RELEASE,
|
||||
|
||||
// Disable tracing as it creates additional requests in an env where subrequests are limited.
|
||||
tracesSampleRate: 0,
|
||||
|
||||
// Disable transactions as it creates additional requests in an env where subrequests are limited.
|
||||
// https://docs.sentry.io/platforms/node/configuration/filtering/#using--3
|
||||
beforeSendTransaction: () => {
|
||||
return null;
|
||||
},
|
||||
});
|
||||
}
|
||||
@@ -1,14 +1,8 @@
|
||||
'use client';
|
||||
|
||||
import { captureException } from '@sentry/nextjs';
|
||||
import NextError from 'next/error';
|
||||
import { useEffect } from 'react';
|
||||
|
||||
export default function GlobalError({ error }: { error: Error }) {
|
||||
useEffect(() => {
|
||||
captureException(error);
|
||||
}, [error]);
|
||||
|
||||
export default function GlobalError() {
|
||||
return (
|
||||
<html lang="en">
|
||||
<body>
|
||||
|
||||
@@ -1,8 +1,5 @@
|
||||
'use client';
|
||||
|
||||
import { captureException, withScope } from '@sentry/nextjs';
|
||||
import React from 'react';
|
||||
|
||||
import { Button } from '@/components/primitives/Button';
|
||||
import { t, useLanguage } from '@/intl/client';
|
||||
import { tcls } from '@/lib/tailwind';
|
||||
@@ -11,18 +8,9 @@ export default function ErrorPage(props: {
|
||||
error: Error & { digest?: string };
|
||||
reset: () => void;
|
||||
}) {
|
||||
const { error, reset } = props;
|
||||
const { reset } = props;
|
||||
const language = useLanguage();
|
||||
|
||||
React.useEffect(() => {
|
||||
withScope((scope) => {
|
||||
if ('_componentStack' in error && error._componentStack) {
|
||||
scope.setExtra('componentStack', error._componentStack);
|
||||
}
|
||||
captureException(error);
|
||||
});
|
||||
}, [error]);
|
||||
|
||||
return (
|
||||
<div
|
||||
className={tcls(
|
||||
|
||||
@@ -25,7 +25,7 @@ import { IntegrationBlock } from './Integration';
|
||||
import { List } from './List';
|
||||
import { ListItem } from './ListItem';
|
||||
import { BlockMath } from './Math';
|
||||
import { OpenAPI } from './OpenAPI';
|
||||
import { OpenAPIOperation, OpenAPISchemas } from './OpenAPI';
|
||||
import { Paragraph } from './Paragraph';
|
||||
import { Quote } from './Quote';
|
||||
import { ReusableContent } from './ReusableContent';
|
||||
@@ -82,7 +82,9 @@ export function Block<T extends DocumentBlock>(props: BlockProps<T>) {
|
||||
return <Table {...props} block={block} />;
|
||||
case 'swagger':
|
||||
case 'openapi-operation':
|
||||
return <OpenAPI {...props} block={block} />;
|
||||
return <OpenAPIOperation {...props} block={block} />;
|
||||
case 'openapi-schemas':
|
||||
return <OpenAPISchemas {...props} block={block} />;
|
||||
case 'embed':
|
||||
return <Embed {...props} block={block} />;
|
||||
case 'blockquote':
|
||||
@@ -156,6 +158,7 @@ export function BlockSkeleton(props: { block: DocumentBlock; style: ClassValue }
|
||||
case 'table':
|
||||
case 'swagger':
|
||||
case 'openapi-operation':
|
||||
case 'openapi-schemas':
|
||||
case 'math':
|
||||
case 'divider':
|
||||
case 'content-ref':
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
'use client';
|
||||
|
||||
import type { DocumentBlockCode } from '@gitbook/api';
|
||||
import { useEffect, useRef, useState } from 'react';
|
||||
import { useEffect, useMemo, useRef, useState } from 'react';
|
||||
|
||||
import { useInViewportListener } from '@/components/hooks/useInViewportListener';
|
||||
import { useScrollListener } from '@/components/hooks/useScrollListener';
|
||||
import { useDebounceCallback, useEventCallback } from 'usehooks-ts';
|
||||
import { useDebounceCallback } from 'usehooks-ts';
|
||||
import type { BlockProps } from '../Block';
|
||||
import { CodeBlockRenderer } from './CodeBlockRenderer';
|
||||
import type { HighlightLine, RenderedInline } from './highlight';
|
||||
@@ -22,53 +22,82 @@ type ClientBlockProps = Pick<BlockProps<DocumentBlockCode>, 'block' | 'style'> &
|
||||
export function ClientCodeBlock(props: ClientBlockProps) {
|
||||
const { block, style, inlines } = props;
|
||||
const blockRef = useRef<HTMLDivElement>(null);
|
||||
const processedRef = useRef(false);
|
||||
const isInViewportRef = useRef<boolean | null>(null);
|
||||
const [lines, setLines] = useState<HighlightLine[]>(() => plainHighlight(block, []));
|
||||
const isInViewportRef = useRef(false);
|
||||
const [isInViewport, setIsInViewport] = useState(false);
|
||||
const plainLines = useMemo(() => plainHighlight(block, []), [block]);
|
||||
const [lines, setLines] = useState<null | HighlightLine[]>(null);
|
||||
|
||||
// Preload the highlighter when the block is mounted.
|
||||
useEffect(() => {
|
||||
import('./highlight').then(({ preloadHighlight }) => preloadHighlight(block));
|
||||
}, [block]);
|
||||
|
||||
const runHighlight = useEventCallback(() => {
|
||||
if (processedRef.current) {
|
||||
return;
|
||||
}
|
||||
if (typeof window !== 'undefined') {
|
||||
import('./highlight').then(({ highlight }) => {
|
||||
highlight(block, inlines).then((lines) => {
|
||||
setLines(lines);
|
||||
processedRef.current = true;
|
||||
});
|
||||
});
|
||||
}
|
||||
});
|
||||
const debouncedRunHighlight = useDebounceCallback(runHighlight, 1000);
|
||||
// When user scrolls, we need to wait for the scroll to finish before running the highlight
|
||||
const isScrollingRef = useRef(false);
|
||||
const onFinishScrolling = useDebounceCallback(() => {
|
||||
isScrollingRef.current = false;
|
||||
|
||||
// If the block is in the viewport after the scroll, we need to run the highlight
|
||||
if (isInViewportRef.current) {
|
||||
setIsInViewport(true);
|
||||
}
|
||||
}, 100);
|
||||
useScrollListener(
|
||||
() => {
|
||||
isScrollingRef.current = true;
|
||||
onFinishScrolling();
|
||||
},
|
||||
useRef(typeof window !== 'undefined' ? window : null)
|
||||
);
|
||||
|
||||
// Detect when the block is in viewport
|
||||
useInViewportListener(
|
||||
blockRef,
|
||||
(isInViewport, disconnect) => {
|
||||
// Disconnect once in viewport
|
||||
if (isInViewport) {
|
||||
disconnect();
|
||||
// If it's initially in viewport, we need to run the highlight
|
||||
if (isInViewportRef.current === null) {
|
||||
runHighlight();
|
||||
}
|
||||
}
|
||||
isInViewportRef.current = isInViewport;
|
||||
if (isScrollingRef.current) {
|
||||
// If the user is scrolling, we don't want to run the highlight
|
||||
// because it will be run when the scroll is finished
|
||||
return;
|
||||
}
|
||||
|
||||
if (isInViewport) {
|
||||
// Disconnect once in viewport
|
||||
disconnect();
|
||||
setIsInViewport(true);
|
||||
}
|
||||
},
|
||||
{ rootMargin: '200px' }
|
||||
);
|
||||
|
||||
const handleScroll = useDebounceCallback(() => {
|
||||
if (isInViewportRef.current) {
|
||||
debouncedRunHighlight();
|
||||
// When the block is visible or updated, we need to re-run the highlight
|
||||
useEffect(() => {
|
||||
if (isInViewport) {
|
||||
// If the block is in viewport, we need to run the highlight
|
||||
let cancelled = false;
|
||||
|
||||
if (typeof window !== 'undefined') {
|
||||
import('./highlight').then(({ highlight }) => {
|
||||
highlight(block, inlines).then((lines) => {
|
||||
if (cancelled) {
|
||||
return;
|
||||
}
|
||||
|
||||
setLines(lines);
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
return () => {
|
||||
cancelled = true;
|
||||
};
|
||||
}
|
||||
}, 80);
|
||||
|
||||
useScrollListener(handleScroll, useRef(typeof window !== 'undefined' ? window : null));
|
||||
// Otherwise if the block is not in viewport, we reset to the plain lines
|
||||
setLines(null);
|
||||
}, [isInViewport, block, inlines]);
|
||||
|
||||
return <CodeBlockRenderer ref={blockRef} block={block} style={style} lines={lines} />;
|
||||
return (
|
||||
<CodeBlockRenderer ref={blockRef} block={block} style={style} lines={lines ?? plainLines} />
|
||||
);
|
||||
}
|
||||
|
||||
+6
-6
@@ -1,6 +1,6 @@
|
||||
import type { JSONDocument } from '@gitbook/api';
|
||||
import { Icon } from '@gitbook/icons';
|
||||
import { OpenAPIOperation } from '@gitbook/react-openapi';
|
||||
import { OpenAPIOperation as BaseOpenAPIOperation } from '@gitbook/react-openapi';
|
||||
|
||||
import { resolveOpenAPIOperationBlock } from '@/lib/openapi/resolveOpenAPIOperationBlock';
|
||||
import { tcls } from '@/lib/tailwind';
|
||||
@@ -12,21 +12,21 @@ import { Heading } from '../Heading';
|
||||
|
||||
import './scalar.css';
|
||||
import './style.css';
|
||||
import type { AnyOpenAPIBlock } from '@/lib/openapi/types';
|
||||
import type { AnyOpenAPIOperationsBlock } from '@/lib/openapi/types';
|
||||
|
||||
/**
|
||||
* Render an openapi block or an openapi-operation block.
|
||||
*/
|
||||
export async function OpenAPI(props: BlockProps<AnyOpenAPIBlock>) {
|
||||
export async function OpenAPIOperation(props: BlockProps<AnyOpenAPIOperationsBlock>) {
|
||||
const { style } = props;
|
||||
return (
|
||||
<div className={tcls('flex w-full', style, 'max-w-full')}>
|
||||
<OpenAPIBody {...props} />
|
||||
<OpenAPIOperationBody {...props} />
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
async function OpenAPIBody(props: BlockProps<AnyOpenAPIBlock>) {
|
||||
async function OpenAPIOperationBody(props: BlockProps<AnyOpenAPIOperationsBlock>) {
|
||||
const { block, context } = props;
|
||||
|
||||
if (!context.contentContext) {
|
||||
@@ -53,7 +53,7 @@ async function OpenAPIBody(props: BlockProps<AnyOpenAPIBlock>) {
|
||||
}
|
||||
|
||||
return (
|
||||
<OpenAPIOperation
|
||||
<BaseOpenAPIOperation
|
||||
data={data}
|
||||
context={{
|
||||
specUrl,
|
||||
@@ -0,0 +1,67 @@
|
||||
import { resolveOpenAPISchemasBlock } from '@/lib/openapi/resolveOpenAPISchemasBlock';
|
||||
import { tcls } from '@/lib/tailwind';
|
||||
import { Icon } from '@gitbook/icons';
|
||||
import { OpenAPISchemas as BaseOpenAPISchemas } from '@gitbook/react-openapi';
|
||||
|
||||
import type { BlockProps } from '../Block';
|
||||
|
||||
import './scalar.css';
|
||||
import './style.css';
|
||||
import type { OpenAPISchemasBlock } from '@/lib/openapi/types';
|
||||
|
||||
/**
|
||||
* Render an openapi-schemas block.
|
||||
*/
|
||||
export async function OpenAPISchemas(props: BlockProps<OpenAPISchemasBlock>) {
|
||||
const { style } = props;
|
||||
return (
|
||||
<div className={tcls('flex w-full', style, 'max-w-full')}>
|
||||
<OpenAPISchemasBody {...props} />
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
async function OpenAPISchemasBody(props: BlockProps<OpenAPISchemasBlock>) {
|
||||
const { block, context } = props;
|
||||
|
||||
if (!context.contentContext) {
|
||||
return null;
|
||||
}
|
||||
|
||||
const { data, specUrl, error } = await resolveOpenAPISchemasBlock({
|
||||
block,
|
||||
context: context.contentContext,
|
||||
});
|
||||
|
||||
if (error) {
|
||||
return (
|
||||
<div className="hidden">
|
||||
<p>
|
||||
Error with {specUrl}: {error.message}
|
||||
</p>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
if (!data || !specUrl) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return (
|
||||
<BaseOpenAPISchemas
|
||||
data={data}
|
||||
context={{
|
||||
specUrl,
|
||||
icons: {
|
||||
chevronDown: <Icon icon="chevron-down" />,
|
||||
chevronRight: <Icon icon="chevron-right" />,
|
||||
plus: <Icon icon="plus" />,
|
||||
},
|
||||
defaultInteractiveOpened: context.mode === 'print',
|
||||
id: block.meta?.id,
|
||||
blockKey: block.key,
|
||||
}}
|
||||
className="openapi-block"
|
||||
/>
|
||||
);
|
||||
}
|
||||
@@ -1 +1,2 @@
|
||||
export * from './OpenAPI';
|
||||
export * from './OpenAPIOperation';
|
||||
export * from './OpenAPISchemas';
|
||||
|
||||
@@ -264,14 +264,18 @@
|
||||
gap: 6px;
|
||||
}
|
||||
.scalar-activate-button {
|
||||
@apply flex gap-1.5 items-center;
|
||||
@apply flex gap-2 items-center;
|
||||
@apply bg-primary-solid text-contrast-primary-solid hover:bg-primary-solid-hover hover:text-contrast-primary-solid-hover contrast-more:ring-1 rounded-md straight-corners:rounded-none place-self-start;
|
||||
@apply ring-1 ring-tint hover:ring-tint-hover;
|
||||
@apply shadow-sm shadow-tint dark:shadow-tint-1 hover:shadow-md active:shadow-none;
|
||||
@apply contrast-more:ring-tint-12 contrast-more:hover:ring-2 contrast-more:hover:ring-tint-12;
|
||||
@apply hover:scale-105 active:scale-100 transition-all;
|
||||
@apply grow-0 shrink-0 truncate;
|
||||
@apply text-sm px-2.5 py-1;
|
||||
@apply text-[13px] px-2 py-0.5 font-mono font-medium [word-spacing:-2px];
|
||||
}
|
||||
|
||||
.scalar-activate-button svg {
|
||||
@apply size-2.5;
|
||||
}
|
||||
|
||||
.scalar-app-loading {
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
/* Layout Components */
|
||||
.openapi-operation {
|
||||
@apply flex-1 flex flex-col gap-4 mb-14;
|
||||
@apply flex-1 flex flex-col gap-8 mb-14;
|
||||
}
|
||||
|
||||
.openapi-schemas {
|
||||
@@ -17,7 +17,7 @@
|
||||
}
|
||||
|
||||
.openapi-summary {
|
||||
@apply flex flex-col items-start justify-start gap-2;
|
||||
@apply flex flex-col items-start justify-start gap-3;
|
||||
}
|
||||
|
||||
.openapi-deprecated {
|
||||
@@ -122,7 +122,7 @@
|
||||
}
|
||||
|
||||
.openapi-column-preview-body {
|
||||
@apply flex flex-col gap-4 sticky top-4 site-header:top-20 site-header-sections:top-32 page-api-block:xl:max-2xl:top-32 print-mode:static;
|
||||
@apply flex flex-col gap-4 sticky top-4 site-header:top-20 site-header-sections:page-has-toc:top-32 page-api-block:xl:max-2xl:top-32 print-mode:static;
|
||||
}
|
||||
|
||||
.openapi-column-preview pre {
|
||||
@@ -391,17 +391,30 @@
|
||||
@apply flex flex-row items-center h-fit;
|
||||
}
|
||||
|
||||
.openapi-codesample-footer {
|
||||
@apply flex w-full justify-end;
|
||||
}
|
||||
|
||||
/* Path */
|
||||
.openapi-path {
|
||||
@apply flex items-center bg-transparent text-sm gap-2 p-2 border rounded-md border-tint-subtle;
|
||||
@apply flex items-center text-sm gap-2 h-fit;
|
||||
}
|
||||
|
||||
.openapi-path-variable {
|
||||
@apply p-px min-w-[1.625rem] text-tint-strong font-normal w-fit justify-center items-center ring-1 ring-inset ring-tint bg-tint rounded text-sm leading-none before:!content-none after:!content-none;
|
||||
}
|
||||
|
||||
.openapi-path-server {
|
||||
@apply text-tint hidden md:inline;
|
||||
}
|
||||
|
||||
.openapi-path .openapi-method {
|
||||
@apply text-[0.813rem] m-0 px-1;
|
||||
@apply text-[0.813rem] m-0 h-full items-center flex px-2;
|
||||
}
|
||||
|
||||
.openapi-path-title {
|
||||
@apply flex-1 relative font-normal whitespace-nowrap overflow-x-auto font-mono text-tint-strong;
|
||||
@apply flex-1 relative font-normal whitespace-nowrap overflow-x-auto font-mono text-tint-strong/10;
|
||||
@apply py-0.5 px-1 rounded hover:bg-tint cursor-pointer transition-colors;
|
||||
scrollbar-width: none;
|
||||
-ms-overflow-style: none;
|
||||
}
|
||||
@@ -520,6 +533,10 @@
|
||||
@apply px-3 py-2 pt-2.5 border-t border-tint-subtle text-[0.813rem] text-tint;
|
||||
}
|
||||
|
||||
.openapi-tabs-footer .openapi-markdown {
|
||||
@apply text-[0.813rem] text-tint;
|
||||
}
|
||||
|
||||
/* Disclosure group */
|
||||
.openapi-disclosure-group {
|
||||
@apply border-b border-tint-subtle relative;
|
||||
@@ -631,3 +648,37 @@
|
||||
.openapi-section-schemas > .openapi-section-body > .openapi-schema-properties > .openapi-schema {
|
||||
@apply p-2.5;
|
||||
}
|
||||
|
||||
.openapi-tooltip {
|
||||
@apply flex items-center gap-1 bg-tint-base border border-tint-subtle text-tint-strong rounded-md font-medium px-1.5 py-0.5 shadow-sm text-[13px];
|
||||
}
|
||||
|
||||
.openapi-tooltip svg {
|
||||
@apply size-3 text-tint-strong;
|
||||
}
|
||||
|
||||
.openapi-tooltip[data-entering] {
|
||||
animation: tooltip-enter 0.2s ease-in-out forwards;
|
||||
}
|
||||
|
||||
.openapi-tooltip[data-exiting] {
|
||||
animation: tooltip-leave 0.2s ease-in-out forwards;
|
||||
}
|
||||
|
||||
@keyframes tooltip-enter {
|
||||
0% {
|
||||
opacity: 0;
|
||||
}
|
||||
100% {
|
||||
opacity: 1;
|
||||
}
|
||||
}
|
||||
|
||||
@keyframes tooltip-leave {
|
||||
0% {
|
||||
opacity: 1;
|
||||
}
|
||||
100% {
|
||||
opacity: 0;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -16,25 +16,20 @@ export function Footer(props: { context: GitBookSiteContext }) {
|
||||
const { customization } = context;
|
||||
|
||||
return (
|
||||
<>
|
||||
<hr className="border-tint-subtle border-t" />
|
||||
<footer
|
||||
className={tcls(
|
||||
'border-tint-subtle border-t',
|
||||
// If the footer only contains a mode toggle, we only show it on smaller screens
|
||||
customization.themes.toggeable &&
|
||||
!customization.footer.copyright &&
|
||||
!customization.footer.logo &&
|
||||
customization.footer.groups?.length === 0
|
||||
? 'xl:hidden'
|
||||
: null
|
||||
)}
|
||||
>
|
||||
<div className="scroll-nojump">
|
||||
<footer
|
||||
className={tcls(
|
||||
CONTAINER_STYLE,
|
||||
'px-4',
|
||||
'mx-auto',
|
||||
'flex',
|
||||
'gap-12',
|
||||
// If the footer only contains a mode toggle, we only show it on smaller screens
|
||||
customization.themes.toggeable &&
|
||||
!customization.footer.copyright &&
|
||||
!customization.footer.logo &&
|
||||
customization.footer.groups?.length === 0
|
||||
? 'xl:hidden'
|
||||
: null
|
||||
)}
|
||||
>
|
||||
<div className={tcls(CONTAINER_STYLE, 'px-4', 'mx-auto', 'flex', 'gap-12')}>
|
||||
<div className="hidden page-no-toc:hidden basis-72 lg:block" />
|
||||
<div
|
||||
className={tcls(
|
||||
@@ -137,8 +132,8 @@ export function Footer(props: { context: GitBookSiteContext }) {
|
||||
</div>
|
||||
</div>
|
||||
<div className="hidden page-no-toc:hidden lg:block xl:basis-56" />
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</>
|
||||
</footer>
|
||||
);
|
||||
}
|
||||
|
||||
@@ -44,7 +44,6 @@ export function Dropdown<E extends HTMLElement>(props: {
|
||||
'absolute',
|
||||
'top-full',
|
||||
'left-0',
|
||||
'z-20',
|
||||
'origin-top-left',
|
||||
'invisible',
|
||||
'transition-opacity',
|
||||
@@ -54,22 +53,24 @@ export function Dropdown<E extends HTMLElement>(props: {
|
||||
className
|
||||
)}
|
||||
>
|
||||
<div
|
||||
className={tcls(
|
||||
'mt-2',
|
||||
'w-full',
|
||||
'bg-tint-base',
|
||||
'rounded-lg',
|
||||
'straight-corners:rounded-sm',
|
||||
'p-2',
|
||||
'shadow-1xs',
|
||||
'overflow-auto',
|
||||
'ring-1',
|
||||
'ring-tint-subtle',
|
||||
'focus:outline-none'
|
||||
)}
|
||||
>
|
||||
{children}
|
||||
<div className="fixed z-50 w-52">
|
||||
<div
|
||||
className={tcls(
|
||||
'mt-2',
|
||||
'w-full',
|
||||
'bg-tint-base',
|
||||
'rounded-lg',
|
||||
'straight-corners:rounded-sm',
|
||||
'p-2',
|
||||
'shadow-1xs',
|
||||
'overflow-auto',
|
||||
'ring-1',
|
||||
'ring-tint-subtle',
|
||||
'focus:outline-none'
|
||||
)}
|
||||
>
|
||||
{children}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -20,7 +20,6 @@ import { SpacesDropdown } from './SpacesDropdown';
|
||||
export function Header(props: { context: GitBookSiteContext; withTopHeader?: boolean }) {
|
||||
const { context, withTopHeader } = props;
|
||||
const { siteSpace, siteSpaces, sections, customization } = context;
|
||||
const isMultiVariants = siteSpaces.length > 1;
|
||||
|
||||
return (
|
||||
<header
|
||||
@@ -31,7 +30,7 @@ export function Header(props: { context: GitBookSiteContext; withTopHeader?: boo
|
||||
`h-[${HEADER_HEIGHT_DESKTOP}px]`,
|
||||
'sticky',
|
||||
'top-0',
|
||||
'z-10',
|
||||
'z-30',
|
||||
'w-full',
|
||||
'flex-none',
|
||||
'shadow-[0px_1px_0px]',
|
||||
@@ -56,11 +55,11 @@ export function Header(props: { context: GitBookSiteContext; withTopHeader?: boo
|
||||
'theme-bold:shadow-tint-12/2'
|
||||
)}
|
||||
>
|
||||
<div className={tcls('scroll-nojump')}>
|
||||
<div className="scroll-nojump">
|
||||
<div
|
||||
className={tcls(
|
||||
'gap-4',
|
||||
'lg:gap-8',
|
||||
'lg:gap-6',
|
||||
'flex',
|
||||
'items-center',
|
||||
'justify-between',
|
||||
@@ -68,14 +67,12 @@ export function Header(props: { context: GitBookSiteContext; withTopHeader?: boo
|
||||
'py-3',
|
||||
'min-h-16',
|
||||
'sm:h-16',
|
||||
isMultiVariants && 'page-no-toc:max-[400px]:flex-wrap',
|
||||
CONTAINER_STYLE
|
||||
)}
|
||||
>
|
||||
<div
|
||||
className={tcls(
|
||||
'flex max-w-full',
|
||||
isMultiVariants && 'page-no-toc:max-[400px]:w-full',
|
||||
'flex max-w-full lg:basis-72',
|
||||
'min-w-0 shrink items-center justify-start gap-2 lg:gap-4'
|
||||
)}
|
||||
>
|
||||
@@ -86,44 +83,36 @@ export function Header(props: { context: GitBookSiteContext; withTopHeader?: boo
|
||||
'text-tint-strong',
|
||||
'theme-bold:text-header-link',
|
||||
'hover:bg-tint-hover',
|
||||
'theme-bold:hover:bg-header-link/3'
|
||||
'theme-bold:hover:bg-header-link/3',
|
||||
'page-no-toc:hidden'
|
||||
)}
|
||||
/>
|
||||
<HeaderLogo context={context} />
|
||||
</div>
|
||||
|
||||
{isMultiVariants && (
|
||||
<div className="mr-auto page-no-toc:flex hidden">
|
||||
<SpacesDropdown
|
||||
context={context}
|
||||
siteSpace={siteSpace}
|
||||
siteSpaces={siteSpaces}
|
||||
className={
|
||||
'theme-bold:bg-header-link/2 theme-bold:text-header-link theme-bold:ring-header-link/4 theme-bold:group-focus-within/dropdown:bg-header-link/3 theme-bold:group-focus-within/dropdown:text-header-link theme-bold:group-focus-within/dropdown:ring-header-link/6 theme-bold:group-hover/dropdown:bg-header-link/3 theme-bold:group-hover/dropdown:text-header-link theme-bold:group-hover/dropdown:ring-header-link/6 theme-bold:contrast-more:bg-header-background theme-bold:contrast-more:text-header-link theme-bold:contrast-more:ring-header-link theme-bold:contrast-more:group-hover/dropdown:text-header-link theme-bold:contrast-more:group-hover/dropdown:ring-header-link theme-bold:contrast-more:group-focus-within/dropdown:text-header-link theme-bold:contrast-more:group-focus-within/dropdown:ring-header-link theme-bold:dark:bg-header-link/2 theme-bold:dark:text-header-link theme-bold:dark:ring-header-link/4 theme-bold:dark:group-hover/dropdown:bg-header-link/3 theme-bold:dark:group-hover/dropdown:text-header-link theme-bold:dark:group-hover/dropdown:ring-header-link/6 theme-bold:contrast-more:dark:group-hover/dropdown:text-header-link theme-bold:contrast-more:dark:group-hover/dropdown:ring-header-link theme-bold:dark:group-focus-within/dropdown:bg-header-link/3 theme-bold:dark:group-focus-within/dropdown:text-header-link theme-bold:dark:group-focus-within/dropdown:ring-header-link/6 theme-bold:contrast-more:dark:group-focus-within/dropdown:text-header-link theme-bold:contrast-more:dark:group-focus-within/dropdown:ring-header-link'
|
||||
}
|
||||
/>
|
||||
</div>
|
||||
)}
|
||||
|
||||
{customization.header.links.length > 0 && (
|
||||
<HeaderLinks>
|
||||
{customization.header.links.map((link, index) => {
|
||||
return <HeaderLink key={index} link={link} context={context} />;
|
||||
})}
|
||||
<HeaderLinkMore
|
||||
label={t(getSpaceLanguage(customization), 'more')}
|
||||
links={customization.header.links}
|
||||
context={context}
|
||||
/>
|
||||
</HeaderLinks>
|
||||
)}
|
||||
<div
|
||||
className={tcls(
|
||||
'flex',
|
||||
'md:min-w-56',
|
||||
'grow-0',
|
||||
'shrink-0',
|
||||
'justify-self-end'
|
||||
'md:basis-56',
|
||||
'justify-self-end',
|
||||
'search' in customization.styling &&
|
||||
customization.styling.search === 'prominent'
|
||||
? [
|
||||
'md:grow-[0.8]',
|
||||
'lg:basis-40',
|
||||
'max-w-lg',
|
||||
'lg:ml-[max(calc((100%-18rem-48rem-3rem)/2),1.5rem)]', // container (100%) - sidebar (18rem) - content (48rem) - margin (3rem)
|
||||
'xl:ml-[max(calc((100%-18rem-48rem-14rem-3rem)/2),1.5rem)]', // container (100%) - sidebar (18rem) - content (48rem) - outline (14rem) - margin (3rem)
|
||||
'page-no-toc:lg:ml-[max(calc((100%-18rem-48rem-18rem-3rem)/2),0rem)]',
|
||||
'page-full-width:lg:ml-[max(calc((100%-18rem-103rem-3rem)/2),1.5rem)]',
|
||||
'page-full-width:2xl:ml-[max(calc((100%-18rem-96rem-14rem+3rem)/2),1.5rem)]',
|
||||
'lg:mr-auto',
|
||||
'order-last',
|
||||
'md:order-[unset]',
|
||||
]
|
||||
: ['order-last']
|
||||
)}
|
||||
>
|
||||
<Suspense fallback={null}>
|
||||
@@ -152,6 +141,7 @@ export function Header(props: { context: GitBookSiteContext; withTopHeader?: boo
|
||||
|
||||
'theme-bold:shadow-none',
|
||||
'theme-bold:hover:shadow-none',
|
||||
'whitespace-nowrap',
|
||||
]}
|
||||
>
|
||||
<span className={tcls('flex-1')}>
|
||||
@@ -166,11 +156,72 @@ export function Header(props: { context: GitBookSiteContext; withTopHeader?: boo
|
||||
</SearchButton>
|
||||
</Suspense>
|
||||
</div>
|
||||
|
||||
{customization.header.links.length > 0 && (
|
||||
<HeaderLinks>
|
||||
{customization.header.links.map((link) => {
|
||||
return (
|
||||
<HeaderLink
|
||||
key={link.title}
|
||||
link={link}
|
||||
context={context}
|
||||
/>
|
||||
);
|
||||
})}
|
||||
<HeaderLinkMore
|
||||
label={t(getSpaceLanguage(customization), 'more')}
|
||||
links={customization.header.links}
|
||||
context={context}
|
||||
/>
|
||||
</HeaderLinks>
|
||||
)}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
{sections ? (
|
||||
<SiteSectionTabs sections={encodeClientSiteSections(context, sections)} />
|
||||
|
||||
{sections || siteSpaces.length > 1 ? (
|
||||
<div className="scroll-nojump">
|
||||
<div
|
||||
className={tcls(
|
||||
'w-full',
|
||||
'overflow-x-scroll',
|
||||
'overflow-y-hidden',
|
||||
'hide-scroll',
|
||||
'-mb-4 pb-4', // Positive padding / negative margin allows the navigation menu indicator to show in a scroll viewƒ
|
||||
!sections ? ['hidden', 'page-no-toc:flex'] : 'flex'
|
||||
)}
|
||||
>
|
||||
<div
|
||||
className={tcls(
|
||||
CONTAINER_STYLE,
|
||||
'page-default-width:max-w-[unset]',
|
||||
'grow',
|
||||
'flex',
|
||||
'items-end',
|
||||
'page-default-width:2xl:px-[calc((100%-1536px+4rem)/2)]'
|
||||
)}
|
||||
>
|
||||
{siteSpaces.length > 1 && (
|
||||
<div
|
||||
id="variants"
|
||||
className="my-2 mr-5 page-no-toc:flex hidden grow border-tint border-r pr-5 *:grow only:mr-0 only:border-none only:pr-0 sm:max-w-64"
|
||||
>
|
||||
<SpacesDropdown
|
||||
context={context}
|
||||
siteSpace={siteSpace}
|
||||
siteSpaces={siteSpaces}
|
||||
className="w-full grow py-1"
|
||||
/>
|
||||
</div>
|
||||
)}
|
||||
{sections && (
|
||||
<SiteSectionTabs
|
||||
sections={encodeClientSiteSections(context, sections)}
|
||||
/>
|
||||
)}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
) : null}
|
||||
</header>
|
||||
);
|
||||
|
||||
@@ -34,7 +34,7 @@ export async function HeaderLink(props: {
|
||||
if (link.links && link.links.length > 0) {
|
||||
return (
|
||||
<Dropdown
|
||||
className="shrink"
|
||||
className={`shrink ${customization.styling.search === 'prominent' ? 'right-0 left-auto' : null}`}
|
||||
button={(buttonProps) => {
|
||||
if (!target || !link.to) {
|
||||
return (
|
||||
@@ -151,8 +151,8 @@ function HeaderItemButton(
|
||||
|
||||
function getHeaderLinkClassName(_props: { headerPreset: CustomizationHeaderPreset }) {
|
||||
return tcls(
|
||||
'flex items-center shrink',
|
||||
'min-w-0',
|
||||
'flex items-center',
|
||||
'shrink',
|
||||
'contrast-more:underline',
|
||||
'truncate',
|
||||
|
||||
|
||||
@@ -45,7 +45,13 @@ export function HeaderLinkMore(props: {
|
||||
|
||||
return (
|
||||
<div className={`${styles.linkEllipsis} z-20 items-center`}>
|
||||
<Dropdown button={renderButton} className="-translate-x-48 md:translate-x-0">
|
||||
<Dropdown
|
||||
button={renderButton}
|
||||
className={tcls(
|
||||
'max-md:right-0 max-md:left-auto',
|
||||
context.customization.styling.search === 'prominent' && 'right-0 left-auto'
|
||||
)}
|
||||
>
|
||||
<DropdownMenu>
|
||||
{links.map((link, index) => (
|
||||
<MoreMenuLink key={index} link={link} context={context} />
|
||||
|
||||
@@ -1,19 +1,21 @@
|
||||
import type React from 'react';
|
||||
|
||||
import { tcls } from '@/lib/tailwind';
|
||||
import { type ClassValue, tcls } from '@/lib/tailwind';
|
||||
|
||||
import styles from './headerLinks.module.css';
|
||||
|
||||
interface HeaderLinksProps {
|
||||
children: React.ReactNode;
|
||||
style?: ClassValue;
|
||||
}
|
||||
|
||||
export async function HeaderLinks({ children }: HeaderLinksProps) {
|
||||
export async function HeaderLinks({ children, style }: HeaderLinksProps) {
|
||||
return (
|
||||
<div
|
||||
className={tcls(
|
||||
styles.containerHeaderlinks,
|
||||
'lg:[&>.button+.button]:-ml-2 z-20 flex min-w-9 shrink grow items-center justify-end gap-x-4 lg:gap-x-6'
|
||||
'lg:[&>.button+.button]:-ml-2 z-20 ml-auto flex min-w-9 shrink grow items-center justify-end gap-x-4 lg:gap-x-6 xl:grow-0',
|
||||
style
|
||||
)}
|
||||
>
|
||||
{children}
|
||||
|
||||
@@ -55,6 +55,7 @@ export async function HeaderLogo(props: HeaderLogoProps) {
|
||||
'min-w-0',
|
||||
'max-w-40',
|
||||
'lg:max-w-64',
|
||||
'site-header-none:page-no-toc:lg:max-w-56',
|
||||
'max-h-10',
|
||||
'lg:max-h-12',
|
||||
'h-full',
|
||||
@@ -84,7 +85,7 @@ function LogoFallback(props: HeaderLogoProps) {
|
||||
<div
|
||||
className={tcls(
|
||||
'text-pretty',
|
||||
'line-clamp-3',
|
||||
'line-clamp-2',
|
||||
'tracking-tight',
|
||||
'max-w-[18ch]',
|
||||
'lg:max-w-[24ch]',
|
||||
|
||||
@@ -54,7 +54,6 @@ export function HeaderMobileMenu(props: Partial<React.ButtonHTMLAttributes<HTMLB
|
||||
'px-2',
|
||||
'rounded',
|
||||
'straight-corners:rounded-sm',
|
||||
'page-no-toc:hidden',
|
||||
props.className
|
||||
)}
|
||||
>
|
||||
|
||||
@@ -63,7 +63,7 @@ export function SpacesDropdown(props: {
|
||||
className
|
||||
)}
|
||||
>
|
||||
<span className={tcls('line-clamp-2', 'grow')}>{siteSpace.title}</span>
|
||||
<span className={tcls('truncate', 'grow')}>{siteSpace.title}</span>
|
||||
<DropdownChevron />
|
||||
</div>
|
||||
)}
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
.containerHeaderlinks {
|
||||
container-type: inline-size;
|
||||
container-name: headerlinks;
|
||||
@media (max-width: 1279px) {
|
||||
.containerHeaderlinks {
|
||||
container-type: inline-size;
|
||||
container-name: headerlinks;
|
||||
}
|
||||
}
|
||||
|
||||
.linkEllipsis {
|
||||
@@ -43,7 +45,7 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
@container headerlinks (width < 600px) {
|
||||
@container headerlinks (width < 550px) {
|
||||
.containerHeaderlinks > :nth-child(n + 4) {
|
||||
display: none;
|
||||
}
|
||||
@@ -54,7 +56,7 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
@container headerlinks (width < 750px) {
|
||||
@container headerlinks (width < 650px) {
|
||||
.containerHeaderlinks > :nth-child(n + 5) {
|
||||
display: none;
|
||||
}
|
||||
@@ -65,7 +67,7 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
@container headerlinks (width < 850px) {
|
||||
@container headerlinks (width < 750px) {
|
||||
.containerHeaderlinks > :nth-child(n + 6) {
|
||||
display: none;
|
||||
}
|
||||
|
||||
@@ -48,8 +48,11 @@ export function PageAside(props: {
|
||||
'group/aside',
|
||||
'hidden',
|
||||
'xl:flex',
|
||||
// 'page-no-toc:lg:flex',
|
||||
'flex-col',
|
||||
'basis-56',
|
||||
// 'page-no-toc:basis-40',
|
||||
// 'page-no-toc:xl:basis-56',
|
||||
'grow-0',
|
||||
'shrink-0',
|
||||
'break-anywhere', // To prevent long words in headings from breaking the layout
|
||||
|
||||
@@ -46,13 +46,13 @@ export function PageBody(props: {
|
||||
// When in api page mode without the aside, we align with the border of the main content
|
||||
'page-api-block:xl:max-2xl:pr-0',
|
||||
// Max size to ensure one column in api is aligned with rest of content (2 x 3xl) + (gap-3 + 2) * px-12
|
||||
'page-api-block:max-w-[1654px]',
|
||||
'page-api-block:mx-auto',
|
||||
'page-api-block:max-w-screen-2xl',
|
||||
'page-api-block:mx-auto'
|
||||
|
||||
page.layout.tableOfContents ? null : 'xl:ml-56'
|
||||
// page.layout.tableOfContents ? null : 'xl:ml-56'
|
||||
) +
|
||||
(asFullWidth ? ' page-full-width' : '') +
|
||||
(!page.layout.tableOfContents ? ' page-no-toc' : '')
|
||||
(asFullWidth ? ' page-full-width' : ' page-default-width') +
|
||||
(!page.layout.tableOfContents ? ' page-no-toc' : ' page-has-toc')
|
||||
}
|
||||
>
|
||||
<PreservePageLayout asFullWidth={asFullWidth} />
|
||||
@@ -72,7 +72,7 @@ export function PageBody(props: {
|
||||
>
|
||||
<DocumentView
|
||||
document={document}
|
||||
style={['[&>*+*]:mt-5', 'grid']}
|
||||
style={['[&>*+*]:mt-5', '[&>*:is(ul,ol)]:mt-2', 'grid']}
|
||||
blockStyle={['page-api-block:ml-0']}
|
||||
context={{
|
||||
mode: 'default',
|
||||
|
||||
@@ -32,7 +32,11 @@ export async function PageCover(props: {
|
||||
'sm:-mx-6',
|
||||
'md:-mx-8',
|
||||
'-lg:mr-8',
|
||||
page.layout.tableOfContents ? 'lg:ml-0' : null,
|
||||
'lg:ml-0',
|
||||
!page.layout.tableOfContents &&
|
||||
context.customization.header.preset !== 'none'
|
||||
? 'lg:-ml-64'
|
||||
: null,
|
||||
]
|
||||
: ['sm:mx-auto', 'max-w-3xl', 'sm:rounded-md', 'mb-8']
|
||||
)}
|
||||
|
||||
@@ -55,7 +55,7 @@ export async function CustomizationRootLayout(props: {
|
||||
lang={customization.internationalization.locale}
|
||||
className={tcls(
|
||||
customization.header.preset === CustomizationHeaderPreset.None
|
||||
? null
|
||||
? 'site-header-none'
|
||||
: 'scroll-pt-[76px]', // Take the sticky header in consideration for the scrolling
|
||||
customization.styling.corners === CustomizationCorners.Straight
|
||||
? ' straight-corners'
|
||||
|
||||
@@ -143,6 +143,10 @@
|
||||
margin-right: 0;
|
||||
width: calc(100% - var(--scrollbar-width));
|
||||
}
|
||||
body:has(.page-full-width) .scroll-nojump {
|
||||
margin-left: 0;
|
||||
width: 100%;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -43,8 +43,8 @@ export function SearchButton(props: { children?: React.ReactNode; style?: ClassV
|
||||
'justify-center',
|
||||
'items-center',
|
||||
'w-full',
|
||||
'px-3',
|
||||
'py-2',
|
||||
'px-3',
|
||||
'gap-2',
|
||||
|
||||
'bg-tint-base',
|
||||
@@ -81,10 +81,11 @@ export function SearchButton(props: { children?: React.ReactNode; style?: ClassV
|
||||
'contrast-more:focus:ring-tint-12',
|
||||
|
||||
'active:shadow-sm',
|
||||
'active:scale-98',
|
||||
'active:scale-100',
|
||||
|
||||
'md:justify-start',
|
||||
'md:w-full',
|
||||
'text-sm',
|
||||
style
|
||||
)}
|
||||
>
|
||||
@@ -99,7 +100,7 @@ export function SearchButton(props: { children?: React.ReactNode; style?: ClassV
|
||||
}
|
||||
|
||||
const Shortcut = () => {
|
||||
const [operatingSystem, setOperatingSystem] = useState('win');
|
||||
const [operatingSystem, setOperatingSystem] = useState<string | null>(null);
|
||||
|
||||
useEffect(() => {
|
||||
function getOperatingSystem() {
|
||||
@@ -114,21 +115,31 @@ const Shortcut = () => {
|
||||
setOperatingSystem(getOperatingSystem());
|
||||
}, []);
|
||||
|
||||
return (
|
||||
return operatingSystem ? (
|
||||
<div
|
||||
className={tcls(
|
||||
'shortcut',
|
||||
'hidden',
|
||||
'md:inline',
|
||||
'md:flex',
|
||||
'gap-0.5',
|
||||
'-mr-1',
|
||||
'justify-end',
|
||||
'text-xs',
|
||||
'text-tint',
|
||||
'contrast-more:text-tint-strong',
|
||||
'whitespace-nowrap',
|
||||
`[font-feature-settings:"calt",_"case"]`
|
||||
`[font-feature-settings:"calt",_"case"]`,
|
||||
'animate-fadeIn'
|
||||
)}
|
||||
>
|
||||
{operatingSystem === 'mac' ? '⌘' : 'Ctrl +'} K
|
||||
<kbd
|
||||
className={`flex h-5 min-w-5 items-center justify-center rounded border border-tint-subtle theme-bold:border-header-link/5 bg-tint-base theme-bold:bg-header-background px-1 ${operatingSystem === 'mac' ? 'text-sm' : ''}`}
|
||||
>
|
||||
{operatingSystem === 'mac' ? '⌘' : 'Ctrl'}
|
||||
</kbd>
|
||||
<kbd className="flex size-5 items-center justify-center rounded border border-tint-subtle theme-bold:border-header-link/5 bg-tint-base theme-bold:bg-header-background">
|
||||
K
|
||||
</kbd>
|
||||
</div>
|
||||
);
|
||||
) : null;
|
||||
};
|
||||
|
||||
@@ -84,7 +84,7 @@ export function SearchModal(props: SearchModalProps) {
|
||||
'bg-tint-12/4',
|
||||
'dark:bg-tint-1/6',
|
||||
'backdrop-blur-2xl',
|
||||
'z-30',
|
||||
'z-50',
|
||||
'px-4',
|
||||
'pt-4',
|
||||
'md:pt-[min(8vh,6rem)]'
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
'use client';
|
||||
|
||||
import { captureException } from '@sentry/nextjs';
|
||||
import { readStreamableValue } from 'ai/rsc';
|
||||
import assertNever from 'assert-never';
|
||||
import React from 'react';
|
||||
@@ -132,12 +131,6 @@ export const SearchResults = React.forwardRef(function SearchResults(
|
||||
}
|
||||
|
||||
if (!results) {
|
||||
captureException(
|
||||
new Error(
|
||||
`corrupt-cache: ${global ? 'searchAllSiteContent' : 'searchSiteSpaceContent'} is ${results}`
|
||||
),
|
||||
{ extra: { results } }
|
||||
);
|
||||
setResultsState({ results: [], fetching: false });
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -13,6 +13,7 @@ import { buildVersion } from '@/lib/build';
|
||||
import { isSiteIndexable } from '@/lib/seo';
|
||||
|
||||
import { GITBOOK_API_PUBLIC_URL, GITBOOK_ASSETS_URL, GITBOOK_ICONS_URL } from '@v2/lib/env';
|
||||
import { getResizedImageURL } from '@v2/lib/images';
|
||||
import { ClientContexts } from './ClientContexts';
|
||||
import { RocketLoaderDetector } from './RocketLoaderDetector';
|
||||
|
||||
@@ -96,33 +97,43 @@ export async function generateSiteLayoutViewport(context: GitBookSiteContext): P
|
||||
}
|
||||
|
||||
export async function generateSiteLayoutMetadata(context: GitBookSiteContext): Promise<Metadata> {
|
||||
const { site, customization, linker } = context;
|
||||
const { site, customization, linker, imageResizer } = context;
|
||||
const customIcon = 'icon' in customization.favicon ? customization.favicon.icon : null;
|
||||
|
||||
const faviconSize = 48;
|
||||
const icons = [
|
||||
{
|
||||
url: customIcon?.light
|
||||
? await getResizedImageURL(imageResizer, customIcon.light, {
|
||||
width: faviconSize,
|
||||
height: faviconSize,
|
||||
})
|
||||
: linker.toAbsoluteURL(
|
||||
linker.toPathInContent('~gitbook/icon?size=small&theme=light')
|
||||
),
|
||||
type: 'image/png',
|
||||
media: '(prefers-color-scheme: light)',
|
||||
},
|
||||
{
|
||||
url: customIcon?.dark
|
||||
? await getResizedImageURL(imageResizer, customIcon.dark, {
|
||||
width: faviconSize,
|
||||
height: faviconSize,
|
||||
})
|
||||
: linker.toAbsoluteURL(
|
||||
linker.toPathInContent('~gitbook/icon?size=small&theme=dark')
|
||||
),
|
||||
type: 'image/png',
|
||||
media: '(prefers-color-scheme: dark)',
|
||||
},
|
||||
];
|
||||
|
||||
return {
|
||||
title: site.title,
|
||||
generator: `GitBook (${buildVersion()})`,
|
||||
icons: {
|
||||
icon: [
|
||||
{
|
||||
url:
|
||||
customIcon?.light ??
|
||||
linker.toAbsoluteURL(
|
||||
linker.toPathInContent('~gitbook/icon?size=small&theme=light')
|
||||
),
|
||||
type: 'image/png',
|
||||
media: '(prefers-color-scheme: light)',
|
||||
},
|
||||
{
|
||||
url:
|
||||
customIcon?.dark ??
|
||||
linker.toAbsoluteURL(
|
||||
linker.toPathInContent('~gitbook/icon?size=small&theme=dark')
|
||||
),
|
||||
type: 'image/png',
|
||||
media: '(prefers-color-scheme: dark)',
|
||||
},
|
||||
],
|
||||
icon: icons,
|
||||
apple: icons,
|
||||
},
|
||||
robots: (await isSiteIndexable(context)) ? 'index, follow' : 'noindex, nofollow',
|
||||
};
|
||||
|
||||
@@ -10,6 +10,7 @@ import { PageBody, PageCover } from '@/components/PageBody';
|
||||
import { getPagePath } from '@/lib/pages';
|
||||
import { isPageIndexable, isSiteIndexable } from '@/lib/seo';
|
||||
|
||||
import { getResizedImageURL } from '@v2/lib/images';
|
||||
import { PageClientLayout } from './PageClientLayout';
|
||||
import { type PagePathParams, fetchPageData, getPathnameParam, normalizePathname } from './fetch';
|
||||
|
||||
@@ -118,7 +119,7 @@ export async function generateSitePageMetadata(props: SitePageProps): Promise<Me
|
||||
}
|
||||
|
||||
const { page, ancestors } = pageTarget;
|
||||
const { site, customization, pages, linker } = context;
|
||||
const { site, customization, pages, linker, imageResizer } = context;
|
||||
|
||||
return {
|
||||
title: [page.title, site.title].filter(Boolean).join(' | '),
|
||||
@@ -131,8 +132,12 @@ export async function generateSitePageMetadata(props: SitePageProps): Promise<Me
|
||||
},
|
||||
openGraph: {
|
||||
images: [
|
||||
customization.socialPreview.url ??
|
||||
linker.toAbsoluteURL(linker.toPathInContent(`~gitbook/ogimage/${page.id}`)),
|
||||
customization.socialPreview.url
|
||||
? await getResizedImageURL(imageResizer, customization.socialPreview.url, {
|
||||
width: 1200,
|
||||
height: 630,
|
||||
})
|
||||
: linker.toAbsoluteURL(linker.toPathInContent(`~gitbook/ogimage/${page.id}`)),
|
||||
],
|
||||
},
|
||||
robots:
|
||||
|
||||
@@ -1,19 +1,20 @@
|
||||
import { Icon, type IconName } from '@gitbook/icons';
|
||||
|
||||
import { tcls } from '@/lib/tailwind';
|
||||
import { type ClassValue, tcls } from '@/lib/tailwind';
|
||||
|
||||
/**
|
||||
* Icon shown beside a section in the site section tabs.
|
||||
*/
|
||||
export function SectionIcon(props: { icon: IconName; isActive: boolean }) {
|
||||
const { icon, isActive } = props;
|
||||
export function SectionIcon(props: { icon: IconName; isActive: boolean; className?: ClassValue }) {
|
||||
const { icon, isActive, className } = props;
|
||||
|
||||
return (
|
||||
<Icon
|
||||
icon={icon}
|
||||
className={tcls(
|
||||
'size-[1em] shrink-0 text-inherit opacity-8',
|
||||
isActive && 'text-inherit opacity-10'
|
||||
isActive && 'text-inherit opacity-10',
|
||||
className
|
||||
)}
|
||||
/>
|
||||
);
|
||||
|
||||
@@ -137,12 +137,13 @@ export function SiteSectionGroupItem(props: {
|
||||
return (
|
||||
<>
|
||||
<button
|
||||
type="button"
|
||||
onClick={(event) => {
|
||||
event.preventDefault();
|
||||
event.stopPropagation();
|
||||
setIsVisible((prev) => !prev);
|
||||
}}
|
||||
className={`group/section-link flex w-full flex-row items-center gap-3 rounded-md straight-corners:rounded-none px-3 py-2 transition-all hover:bg-tint-hover hover:text-tint-strong contrast-more:hover:ring-1 contrast-more:hover:ring-tint ${
|
||||
className={`group/section-link flex w-full flex-row items-center gap-3 rounded-md straight-corners:rounded-none px-3 py-2 text-left transition-all hover:bg-tint-hover hover:text-tint-strong contrast-more:hover:ring-1 contrast-more:hover:ring-tint ${
|
||||
isActiveGroup
|
||||
? 'font-semibold text-primary hover:bg-primary-hover hover:text-primary-strong contrast-more:text-primary-strong contrast-more:hover:ring-1 contrast-more:hover:ring-primary-hover'
|
||||
: null
|
||||
|
||||
@@ -6,7 +6,6 @@ import React from 'react';
|
||||
|
||||
import { Link } from '@/components/primitives';
|
||||
import { tcls } from '@/lib/tailwind';
|
||||
|
||||
import { SectionIcon } from './SectionIcon';
|
||||
import type { ClientSiteSection, ClientSiteSections } from './encodeClientSiteSections';
|
||||
|
||||
@@ -21,26 +20,27 @@ export function SiteSectionTabs(props: { sections: ClientSiteSections }) {
|
||||
} = props;
|
||||
const [value, setValue] = React.useState<string | null>();
|
||||
const [offset, setOffset] = React.useState<number | null>(null);
|
||||
const scrollableViewRef = React.useRef<HTMLDivElement>(null);
|
||||
const menuContainerRef = React.useRef<HTMLDivElement>(null);
|
||||
|
||||
const onNodeUpdate = (trigger: HTMLButtonElement | null, itemValue: string, size = 0) => {
|
||||
const padding = 16;
|
||||
const margin = -12; // Offsetting the menu container's negative margin
|
||||
const windowWidth = document.documentElement.clientWidth;
|
||||
const windowBuffer = 16; // constrain to within the window with some buffer on the left and right we don't want the menu to enter
|
||||
const viewportWidth =
|
||||
size < MIN_ITEMS_FOR_COLS
|
||||
? VIEWPORT_ITEM_WIDTH + padding
|
||||
: VIEWPORT_ITEM_WIDTH * 2 + padding;
|
||||
const minOffset = 0 - (menuContainerRef.current?.offsetLeft ?? 0) + margin;
|
||||
const maxOffset = minOffset + windowWidth - viewportWidth;
|
||||
|
||||
if (windowWidth < 768) {
|
||||
// if the screen is small don't offset the menu
|
||||
setOffset(0);
|
||||
setOffset(minOffset + windowBuffer);
|
||||
} else if (trigger && value === itemValue) {
|
||||
const padding = 16;
|
||||
const viewportWidth =
|
||||
size < MIN_ITEMS_FOR_COLS
|
||||
? VIEWPORT_ITEM_WIDTH + padding
|
||||
: VIEWPORT_ITEM_WIDTH * 2 + padding;
|
||||
const scrollLeft = scrollableViewRef.current?.scrollLeft ?? 0;
|
||||
const triggerOffset = trigger.offsetLeft - scrollLeft; // offset of the trigger from the left edge including scrolling
|
||||
const bufferLeft = 2; // offset the menu viewport should not pass on the left side of window
|
||||
const bufferRight = windowWidth - (16 + viewportWidth); // offset the menu viewport should not pass on the right side of the window
|
||||
const position = minOffset + trigger?.getBoundingClientRect().left;
|
||||
setOffset(
|
||||
// constrain to within the window with some buffer on the left and right we don't want the menu to enter
|
||||
Math.min(bufferRight, Math.max(bufferLeft, Math.round(triggerOffset)))
|
||||
Math.min(maxOffset - windowBuffer, Math.max(minOffset + windowBuffer, position))
|
||||
);
|
||||
} else if (!value) {
|
||||
setOffset(null);
|
||||
@@ -50,14 +50,16 @@ export function SiteSectionTabs(props: { sections: ClientSiteSections }) {
|
||||
return sectionsAndGroups.length > 0 ? (
|
||||
<NavigationMenu.Root
|
||||
aria-label="Sections"
|
||||
id="sections"
|
||||
onValueChange={setValue}
|
||||
className="relative z-10 mx-auto flex w-full max-w-screen-2xl page-full-width:max-w-full flex-nowrap items-center"
|
||||
className="z-10 flex w-full flex-nowrap items-center"
|
||||
>
|
||||
<div
|
||||
ref={scrollableViewRef}
|
||||
className="hide-scroll -mb-4 w-full overflow-y-hidden overflow-x-scroll pb-4" /* Positive padding / negative margin allows the navigation menu indicator to show in a scroll view */
|
||||
ref={menuContainerRef}
|
||||
className="-mx-3"
|
||||
// className="-mb-4 pb-4" /* Positive padding / negative margin allows the navigation menu indicator to show in a scroll view */
|
||||
>
|
||||
<NavigationMenu.List className="center m-0 flex list-none gap-2 bg-transparent px-1 sm:px-3 md:px-5">
|
||||
<NavigationMenu.List className="center m-0 flex list-none gap-2 bg-transparent">
|
||||
{sectionsAndGroups.map((sectionOrGroup) => {
|
||||
const { id, title, icon } = sectionOrGroup;
|
||||
const isGroup = sectionOrGroup.object === 'site-section-group';
|
||||
@@ -110,10 +112,10 @@ export function SiteSectionTabs(props: { sections: ClientSiteSections }) {
|
||||
);
|
||||
})}
|
||||
<NavigationMenu.Indicator
|
||||
className="top-full z-0 flex h-3 items-end justify-center duration-150 motion-safe:transition-[width,_transform] data-[state=hidden]:motion-safe:animate-fadeOut data-[state=visible]:motion-safe:animate-fadeIn"
|
||||
className="fixed top-full z-50 flex h-3 items-end justify-center duration-150 motion-safe:transition-[width,_transform] data-[state=hidden]:motion-safe:animate-fadeOut data-[state=visible]:motion-safe:animate-fadeIn"
|
||||
aria-hidden
|
||||
>
|
||||
<div className="relative top-[70%] size-3 rotate-[225deg] rounded-tl-sm bg-tint shadow-1xs shadow-dark/1 dark:shadow-dark/4" />
|
||||
<div className="relative top-1/2 size-3 rotate-45 rounded-tl-sm border-tint-subtle border-t border-l bg-tint-base" />
|
||||
</NavigationMenu.Indicator>
|
||||
</NavigationMenu.List>
|
||||
</div>
|
||||
@@ -121,11 +123,11 @@ export function SiteSectionTabs(props: { sections: ClientSiteSections }) {
|
||||
className="absolute top-full flex transition-transform duration-200 ease-in-out"
|
||||
style={{
|
||||
display: offset === null ? 'none' : undefined,
|
||||
transform: offset ? `translateX(${offset}px)` : undefined,
|
||||
transform: offset ? `translateX(${offset}px) translateZ(0)` : 'translateZ(0)', // TranslateZ is needed to force a stacking context, fixing a rendering bug on Safari
|
||||
}}
|
||||
>
|
||||
<NavigationMenu.Viewport
|
||||
className="relative mt-3 ml-4 h-[var(--radix-navigation-menu-viewport-height)] w-[calc(100vw_-_2rem)] origin-[top_center] overflow-hidden rounded straight-corners:rounded-none bg-tint shadow-1xs shadow-dark/1 duration-250 data-[state=closed]:duration-150 motion-safe:transition-[width,_height,_transform] data-[state=closed]:motion-safe:animate-scaleOut data-[state=open]:motion-safe:animate-scaleIn md:mx-0 md:w-[var(--radix-navigation-menu-viewport-width)] dark:shadow-dark/4"
|
||||
className="relative mt-3 h-[var(--radix-navigation-menu-viewport-height)] w-[calc(100vw_-_2rem)] origin-[top_center] overflow-hidden rounded-lg straight-corners:rounded-sm bg-tint-base shadow-lg shadow-tint-10/6 ring-1 ring-tint-subtle duration-250 data-[state=closed]:duration-150 motion-safe:transition-[width,_height,_transform] data-[state=closed]:motion-safe:animate-scaleOut data-[state=open]:motion-safe:animate-scaleIn md:mx-0 md:w-[var(--radix-navigation-menu-viewport-width)] dark:shadow-tint-1/6"
|
||||
style={{
|
||||
translate:
|
||||
undefined /* don't move this to a Tailwind class as Radix renders viewport incorrectly for a few frames */,
|
||||
@@ -218,7 +220,7 @@ function SectionGroupTileList(props: {
|
||||
return (
|
||||
<ul
|
||||
className={tcls(
|
||||
'grid w-full p-2 sm:grid-cols-1 md:w-max',
|
||||
'grid w-full gap-1 p-2 sm:grid-cols-1 md:w-max',
|
||||
sections.length < MIN_ITEMS_FOR_COLS ? 'md:grid-cols-1' : 'md:grid-cols-2'
|
||||
)}
|
||||
>
|
||||
@@ -244,17 +246,23 @@ function SectionGroupTile(props: { section: ClientSiteSection; isActive: boolean
|
||||
<Link
|
||||
href={url}
|
||||
className={tcls(
|
||||
'flex min-h-12 w-full select-none flex-col gap-2 rounded p-3 transition-colors hover:bg-tint-hover',
|
||||
isActive
|
||||
? 'text-primary hover:text-primary-strong focus:text-primary-strong'
|
||||
: 'text-tint hover:text-tint-strong focus:text-tint-strong'
|
||||
'flex w-full select-none flex-col gap-1 rounded straight-corners:rounded-none px-3 py-2 transition-colors hover:bg-tint-hover',
|
||||
isActive ? 'text-primary' : 'text-tint-strong'
|
||||
)}
|
||||
>
|
||||
<div className="flex w-full items-center gap-2 font-medium light:text-dark dark:text-light">
|
||||
{icon ? <SectionIcon isActive={false} icon={icon as IconName} /> : null}
|
||||
<span className="min-w-0 truncate">{title}</span>
|
||||
<div className="flex w-full gap-2">
|
||||
{icon ? (
|
||||
<SectionIcon
|
||||
className="mt-[3px]"
|
||||
isActive={false}
|
||||
icon={icon as IconName}
|
||||
/>
|
||||
) : null}
|
||||
{title}
|
||||
</div>
|
||||
<p className="text-tint-subtle">{section.description}</p>
|
||||
{section.description ? (
|
||||
<p className="text-tint-subtle">{section.description}</p>
|
||||
) : null}
|
||||
</Link>
|
||||
</li>
|
||||
);
|
||||
|
||||
@@ -62,73 +62,81 @@ export function SpaceLayout(props: {
|
||||
spaceId={context.space.id}
|
||||
>
|
||||
<Header withTopHeader={withTopHeader} context={context} />
|
||||
<div
|
||||
className={tcls(
|
||||
'flex',
|
||||
'flex-col',
|
||||
'lg:flex-row',
|
||||
CONTAINER_STYLE,
|
||||
<div className="scroll-nojump">
|
||||
<div
|
||||
className={tcls(
|
||||
'flex',
|
||||
'flex-col',
|
||||
'lg:flex-row',
|
||||
CONTAINER_STYLE,
|
||||
|
||||
// Ensure the footer is display below the viewport even if the content is not enough
|
||||
withFooter && 'min-h-[calc(100vh-64px)]',
|
||||
withTopHeader ? null : 'lg:min-h-screen'
|
||||
)}
|
||||
>
|
||||
<TableOfContents
|
||||
context={context}
|
||||
header={
|
||||
withTopHeader ? null : (
|
||||
<div
|
||||
className={tcls(
|
||||
'hidden',
|
||||
'pr-4',
|
||||
'lg:flex',
|
||||
'grow-0',
|
||||
'flex-wrap',
|
||||
'dark:shadow-light/1'
|
||||
)}
|
||||
>
|
||||
<HeaderLogo context={context} />
|
||||
</div>
|
||||
)
|
||||
}
|
||||
innerHeader={
|
||||
// displays the search button and/or the space dropdown in the ToC according to the header/variant settings. E.g if there is no header, the search button will be displayed in the ToC.
|
||||
<>
|
||||
{!withTopHeader && (
|
||||
<div className={tcls('hidden', 'lg:block')}>
|
||||
<React.Suspense fallback={null}>
|
||||
<SearchButton>
|
||||
<span className={tcls('flex-1')}>
|
||||
{t(
|
||||
getSpaceLanguage(customization),
|
||||
customization.aiSearch.enabled
|
||||
? 'search_or_ask'
|
||||
: 'search'
|
||||
)}
|
||||
</span>
|
||||
</SearchButton>
|
||||
</React.Suspense>
|
||||
// Ensure the footer is display below the viewport even if the content is not enough
|
||||
withFooter && 'min-h-[calc(100vh-64px)]',
|
||||
withTopHeader ? null : 'lg:min-h-screen'
|
||||
)}
|
||||
>
|
||||
<TableOfContents
|
||||
context={context}
|
||||
header={
|
||||
withTopHeader ? null : (
|
||||
<div
|
||||
className={tcls(
|
||||
'hidden',
|
||||
'pr-4',
|
||||
'lg:flex',
|
||||
'grow-0',
|
||||
'flex-wrap',
|
||||
'dark:shadow-light/1',
|
||||
'text-base/tight'
|
||||
)}
|
||||
>
|
||||
<HeaderLogo context={context} />
|
||||
</div>
|
||||
)}
|
||||
{!withTopHeader && withSections && sections && (
|
||||
<SiteSectionList
|
||||
className={tcls('hidden', 'lg:block')}
|
||||
sections={encodeClientSiteSections(context, sections)}
|
||||
/>
|
||||
)}
|
||||
{isMultiVariants && (
|
||||
<SpacesDropdown
|
||||
context={context}
|
||||
siteSpace={siteSpace}
|
||||
siteSpaces={siteSpaces}
|
||||
className={tcls('w-full')}
|
||||
/>
|
||||
)}
|
||||
</>
|
||||
}
|
||||
/>
|
||||
<div className={tcls('flex-1', 'flex', 'flex-col')}>{children}</div>
|
||||
)
|
||||
}
|
||||
innerHeader={
|
||||
// displays the search button and/or the space dropdown in the ToC according to the header/variant settings. E.g if there is no header, the search button will be displayed in the ToC.
|
||||
<>
|
||||
{!withTopHeader && (
|
||||
<div className={tcls('hidden', 'lg:block')}>
|
||||
<React.Suspense fallback={null}>
|
||||
<SearchButton>
|
||||
<span className={tcls('flex-1')}>
|
||||
{t(
|
||||
getSpaceLanguage(customization),
|
||||
customization.aiSearch.enabled
|
||||
? 'search_or_ask'
|
||||
: 'search'
|
||||
)}
|
||||
...
|
||||
</span>
|
||||
</SearchButton>
|
||||
</React.Suspense>
|
||||
</div>
|
||||
)}
|
||||
{!withTopHeader && withSections && sections && (
|
||||
<SiteSectionList
|
||||
className={tcls('hidden', 'lg:block')}
|
||||
sections={encodeClientSiteSections(context, sections)}
|
||||
/>
|
||||
)}
|
||||
{isMultiVariants && (
|
||||
<SpacesDropdown
|
||||
context={context}
|
||||
siteSpace={siteSpace}
|
||||
siteSpaces={siteSpaces}
|
||||
className={tcls(
|
||||
'w-full',
|
||||
'page-no-toc:hidden',
|
||||
'site-header-none:page-no-toc:flex'
|
||||
)}
|
||||
/>
|
||||
)}
|
||||
</>
|
||||
}
|
||||
/>
|
||||
<div className={tcls('flex-1', 'flex', 'flex-col')}>{children}</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{withFooter ? <Footer context={context} /> : null}
|
||||
|
||||
@@ -21,12 +21,13 @@ export function TableOfContents(props: {
|
||||
data-testid="table-of-contents"
|
||||
className={tcls(
|
||||
'group',
|
||||
'page-no-toc:hidden',
|
||||
'text-sm',
|
||||
|
||||
'grow-0',
|
||||
'shrink-0',
|
||||
'basis-full',
|
||||
'lg:basis-72',
|
||||
'page-no-toc:lg:basis-56',
|
||||
|
||||
'relative',
|
||||
'z-[1]',
|
||||
@@ -46,10 +47,14 @@ export function TableOfContents(props: {
|
||||
'pt-6',
|
||||
'pb-4',
|
||||
'sidebar-filled:lg:pr-6',
|
||||
'page-no-toc:lg:pr-0',
|
||||
|
||||
'hidden',
|
||||
'navigation-open:flex',
|
||||
'navigation-open:!flex',
|
||||
'lg:flex',
|
||||
'page-no-toc:lg:hidden',
|
||||
'page-no-toc:xl:flex',
|
||||
'site-header-none:page-no-toc:lg:flex',
|
||||
'flex-col',
|
||||
'gap-4',
|
||||
|
||||
@@ -73,6 +78,7 @@ export function TableOfContents(props: {
|
||||
'theme-bold-tint:bg-tint-subtle',
|
||||
'[html.sidebar-filled.theme-muted_&]:bg-tint-base',
|
||||
'[html.sidebar-filled.theme-bold.tint_&]:bg-tint-base',
|
||||
'page-no-toc:!bg-transparent',
|
||||
|
||||
'sidebar-filled:rounded-xl',
|
||||
'straight-corners:rounded-none'
|
||||
@@ -101,7 +107,11 @@ export function TableOfContents(props: {
|
||||
rootPages={pages}
|
||||
pages={pages}
|
||||
context={context}
|
||||
style={tcls('sidebar-list-line:border-l', 'border-tint-subtle')}
|
||||
style={tcls(
|
||||
'page-no-toc:hidden',
|
||||
'sidebar-list-line:border-l',
|
||||
'border-tint-subtle'
|
||||
)}
|
||||
/>
|
||||
{customization.trademark.enabled ? (
|
||||
<Trademark
|
||||
|
||||
@@ -25,7 +25,6 @@ export function Trademark(props: {
|
||||
'relative',
|
||||
'z-[2]',
|
||||
'lg:absolute',
|
||||
'mt-6',
|
||||
|
||||
'left-0',
|
||||
'right-2',
|
||||
@@ -34,6 +33,7 @@ export function Trademark(props: {
|
||||
'pointer-events-none',
|
||||
'sidebar-filled:pl-2',
|
||||
'sidebar-filled:pb-2',
|
||||
'sidebar-filled:page-no-toc:p-0',
|
||||
|
||||
'bg-tint-base',
|
||||
'sidebar-filled:bg-tint-subtle',
|
||||
@@ -55,7 +55,8 @@ export function Trademark(props: {
|
||||
'theme-muted:before:to-tint-subtle',
|
||||
'theme-bold-tint:before:to-tint-subtle',
|
||||
'[html.sidebar-filled.theme-muted_&]:before:to-tint-base',
|
||||
'[html.sidebar-filled.theme-bold.tint_&]:before:to-tint-base'
|
||||
'[html.sidebar-filled.theme-bold.tint_&]:before:to-tint-base',
|
||||
'page-no-toc:before:!to-transparent'
|
||||
)}
|
||||
>
|
||||
<TrademarkLink {...props} />
|
||||
@@ -85,6 +86,9 @@ export function TrademarkLink(props: {
|
||||
href={url.toString()}
|
||||
className={tcls(
|
||||
'text-sm',
|
||||
// 'page-no-toc:lg:max-xl:text-xs',
|
||||
// 'page-no-toc:lg:max-xl:px-3',
|
||||
// 'page-no-toc:lg:max-xl:py-3',
|
||||
'font-semibold',
|
||||
'text-tint',
|
||||
|
||||
@@ -93,7 +97,9 @@ export function TrademarkLink(props: {
|
||||
'items-center',
|
||||
'px-5',
|
||||
'py-4',
|
||||
|
||||
'sidebar-filled:px-3',
|
||||
'sidebar-filled:page-no-toc:lg:px-5',
|
||||
|
||||
'rounded-lg',
|
||||
'straight-corners:rounded-none',
|
||||
@@ -114,8 +120,22 @@ export function TrademarkLink(props: {
|
||||
placement,
|
||||
}}
|
||||
>
|
||||
<Icon icon="gitbook" className={tcls('size-5', 'mr-3')} />
|
||||
{t(language, 'powered_by_gitbook')}
|
||||
<Icon
|
||||
icon="gitbook"
|
||||
className={tcls(
|
||||
'size-5',
|
||||
// 'page-no-toc:lg:max-xl:size-4',
|
||||
'shrink-0'
|
||||
)}
|
||||
/>
|
||||
<span
|
||||
className={tcls(
|
||||
'ml-3'
|
||||
// 'page-no-toc:lg:max-xl:ml-2'
|
||||
)}
|
||||
>
|
||||
{t(language, 'powered_by_gitbook')}
|
||||
</span>
|
||||
</Link>
|
||||
);
|
||||
}
|
||||
|
||||
-7
@@ -1,6 +1,5 @@
|
||||
import hash from 'object-hash';
|
||||
|
||||
import { captureException } from '../../sentry';
|
||||
import { race, singletonMap } from '../async';
|
||||
import { type TraceSpan, trace } from '../tracing';
|
||||
import { assertIsNotV2 } from '../v2';
|
||||
@@ -159,17 +158,11 @@ export function cache<Args extends any[], Result>(
|
||||
}
|
||||
|
||||
// Detect empty cache entries to avoid returning them.
|
||||
// Also log in Sentry to investigate what cache is returning empty entries.
|
||||
if (
|
||||
entry.data &&
|
||||
typeof entry.data === 'object' &&
|
||||
Object.keys(entry.data).length === 0
|
||||
) {
|
||||
captureException(
|
||||
new Error(
|
||||
`Cache entry ${key} from ${backendName} is an empty object`
|
||||
)
|
||||
);
|
||||
return null;
|
||||
}
|
||||
|
||||
|
||||
@@ -1,18 +1,24 @@
|
||||
import { parseOpenAPI } from '@gitbook/openapi-parser';
|
||||
|
||||
import { type CacheFunctionOptions, cache, noCacheFetchOptions } from '@/lib/cache';
|
||||
import type { ResolveOpenAPIBlockArgs } from '@/lib/openapi/types';
|
||||
import type {
|
||||
AnyOpenAPIOperationsBlock,
|
||||
OpenAPISchemasBlock,
|
||||
ResolveOpenAPIBlockArgs,
|
||||
} from '@/lib/openapi/types';
|
||||
import { assert } from 'ts-essentials';
|
||||
import { resolveContentRef } from '../references';
|
||||
import { isV2 } from '../v2';
|
||||
import { enrichFilesystem } from './enrich';
|
||||
import type { FetchOpenAPIFilesystemResult } from './types';
|
||||
|
||||
type AnyOpenAPIBlock = AnyOpenAPIOperationsBlock | OpenAPISchemasBlock;
|
||||
|
||||
/**
|
||||
* Fetch OpenAPI block.
|
||||
*/
|
||||
export async function fetchOpenAPIFilesystem(
|
||||
args: ResolveOpenAPIBlockArgs
|
||||
args: ResolveOpenAPIBlockArgs<AnyOpenAPIBlock>
|
||||
): Promise<FetchOpenAPIFilesystemResult> {
|
||||
const { context, block } = args;
|
||||
|
||||
@@ -50,7 +56,7 @@ const fetchFilesystemV1 = cache({
|
||||
get: async (url: string, options: CacheFunctionOptions) => {
|
||||
const richFilesystem = await fetchFilesystemUncached(url, options);
|
||||
return {
|
||||
// Cache for 4 hours
|
||||
// Cache for 24 hours
|
||||
ttl: 24 * 60 * 60,
|
||||
// Revalidate every 2 hours
|
||||
revalidateBefore: 22 * 60 * 60,
|
||||
|
||||
@@ -1,18 +1,25 @@
|
||||
import { fetchOpenAPIFilesystem } from '@/lib/openapi/fetch';
|
||||
import { OpenAPIParseError } from '@gitbook/openapi-parser';
|
||||
import { type OpenAPIOperationData, resolveOpenAPIOperation } from '@gitbook/react-openapi';
|
||||
import type { AnyOpenAPIBlock, ResolveOpenAPIBlockArgs, ResolveOpenAPIBlockResult } from './types';
|
||||
import type {
|
||||
AnyOpenAPIOperationsBlock,
|
||||
ResolveOpenAPIBlockArgs,
|
||||
ResolveOpenAPIBlockResult,
|
||||
} from './types';
|
||||
|
||||
type ResolveOpenAPIOperationBlockResult = ResolveOpenAPIBlockResult<OpenAPIOperationData>;
|
||||
|
||||
const weakmap = new WeakMap<AnyOpenAPIBlock, Promise<ResolveOpenAPIOperationBlockResult>>();
|
||||
const weakmap = new WeakMap<
|
||||
AnyOpenAPIOperationsBlock,
|
||||
Promise<ResolveOpenAPIOperationBlockResult>
|
||||
>();
|
||||
|
||||
/**
|
||||
* Cache the result of resolving an OpenAPI block.
|
||||
* It is important because the resolve is called in sections and in the block itself.
|
||||
*/
|
||||
export function resolveOpenAPIOperationBlock(
|
||||
args: ResolveOpenAPIBlockArgs
|
||||
args: ResolveOpenAPIBlockArgs<AnyOpenAPIOperationsBlock>
|
||||
): Promise<ResolveOpenAPIOperationBlockResult> {
|
||||
if (weakmap.has(args.block)) {
|
||||
return weakmap.get(args.block)!;
|
||||
@@ -27,7 +34,7 @@ export function resolveOpenAPIOperationBlock(
|
||||
* Resolve OpenAPI operation block.
|
||||
*/
|
||||
async function baseResolveOpenAPIOperationBlock(
|
||||
args: ResolveOpenAPIBlockArgs
|
||||
args: ResolveOpenAPIBlockArgs<AnyOpenAPIOperationsBlock>
|
||||
): Promise<ResolveOpenAPIOperationBlockResult> {
|
||||
const { context, block } = args;
|
||||
if (!block.data.path || !block.data.method) {
|
||||
|
||||
@@ -1,19 +1,22 @@
|
||||
import { fetchOpenAPIFilesystem } from '@/lib/openapi/fetch';
|
||||
import type { ResolveOpenAPIBlockResult } from '@/lib/openapi/types';
|
||||
import { OpenAPIParseError } from '@gitbook/openapi-parser';
|
||||
import { type OpenAPISchemasData, resolveOpenAPISchemas } from '@gitbook/react-openapi';
|
||||
import type { AnyOpenAPIBlock, ResolveOpenAPIBlockArgs } from './types';
|
||||
import { fetchOpenAPIFilesystem } from './fetch';
|
||||
import type {
|
||||
OpenAPISchemasBlock,
|
||||
ResolveOpenAPIBlockArgs,
|
||||
ResolveOpenAPIBlockResult,
|
||||
} from './types';
|
||||
|
||||
type ResolveOpenAPISchemasBlockResult = ResolveOpenAPIBlockResult<OpenAPISchemasData>;
|
||||
|
||||
const weakmap = new WeakMap<AnyOpenAPIBlock, Promise<ResolveOpenAPISchemasBlockResult>>();
|
||||
const weakmap = new WeakMap<OpenAPISchemasBlock, Promise<ResolveOpenAPISchemasBlockResult>>();
|
||||
|
||||
/**
|
||||
* Cache the result of resolving an OpenAPI block.
|
||||
* It is important because the resolve is called in sections and in the block itself.
|
||||
*/
|
||||
export function resolveOpenAPISchemasBlock(
|
||||
args: ResolveOpenAPIBlockArgs
|
||||
args: ResolveOpenAPIBlockArgs<OpenAPISchemasBlock>
|
||||
): Promise<ResolveOpenAPISchemasBlockResult> {
|
||||
if (weakmap.has(args.block)) {
|
||||
return weakmap.get(args.block)!;
|
||||
@@ -28,10 +31,10 @@ export function resolveOpenAPISchemasBlock(
|
||||
* Resolve OpenAPI schemas block.
|
||||
*/
|
||||
async function baseResolveOpenAPISchemasBlock(
|
||||
args: ResolveOpenAPIBlockArgs
|
||||
args: ResolveOpenAPIBlockArgs<OpenAPISchemasBlock>
|
||||
): Promise<ResolveOpenAPISchemasBlockResult> {
|
||||
const { context, block } = args;
|
||||
if (!block.data.path || !block.data.method) {
|
||||
if (!block.data.schemas || !block.data.schemas.length) {
|
||||
return { data: null, specUrl: null };
|
||||
}
|
||||
|
||||
@@ -42,7 +45,9 @@ async function baseResolveOpenAPISchemasBlock(
|
||||
return { data: null, specUrl: null };
|
||||
}
|
||||
|
||||
const data = await resolveOpenAPISchemas(filesystem);
|
||||
const data = await resolveOpenAPISchemas(filesystem, {
|
||||
schemas: block.data.schemas,
|
||||
});
|
||||
|
||||
return { data, specUrl };
|
||||
} catch (error) {
|
||||
|
||||
@@ -1,15 +1,26 @@
|
||||
import type { DocumentBlockOpenAPI, DocumentBlockOpenAPIOperation } from '@gitbook/api';
|
||||
import type {
|
||||
DocumentBlockOpenAPI,
|
||||
DocumentBlockOpenAPIOperation,
|
||||
DocumentBlockOpenAPISchemas,
|
||||
} from '@gitbook/api';
|
||||
import type { Filesystem, OpenAPIParseError, OpenAPIV3xDocument } from '@gitbook/openapi-parser';
|
||||
import type { GitBookAnyContext } from '@v2/lib/context';
|
||||
|
||||
//!!TODO: Add DocumentBlockOpenAPISchemas when available in @gitbook/api
|
||||
export type AnyOpenAPIBlock = DocumentBlockOpenAPI | DocumentBlockOpenAPIOperation;
|
||||
/**
|
||||
* Type for both OpenAPI & OpenAPIOperation block
|
||||
*/
|
||||
export type AnyOpenAPIOperationsBlock = DocumentBlockOpenAPI | DocumentBlockOpenAPIOperation;
|
||||
|
||||
/**
|
||||
* Type for OpenAPI Schemas block
|
||||
*/
|
||||
export type OpenAPISchemasBlock = DocumentBlockOpenAPISchemas;
|
||||
|
||||
/**
|
||||
* Arguments for resolving OpenAPI block.
|
||||
*/
|
||||
export type ResolveOpenAPIBlockArgs = {
|
||||
block: AnyOpenAPIBlock;
|
||||
export type ResolveOpenAPIBlockArgs<T> = {
|
||||
block: T;
|
||||
context: GitBookAnyContext;
|
||||
};
|
||||
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
import { type ContentAPITokenPayload, CustomizationThemeMode, GitBookAPI } from '@gitbook/api';
|
||||
import { setContext, setTag } from '@sentry/nextjs';
|
||||
import { getURLLookupAlternatives, normalizeURL } from '@v2/lib/data';
|
||||
import assertNever from 'assert-never';
|
||||
import jwt from 'jsonwebtoken';
|
||||
@@ -96,14 +95,6 @@ export async function middleware(request: NextRequest) {
|
||||
const { url, mode } = getInputURL(request);
|
||||
const isServerAction = request.headers.has('Next-Action');
|
||||
|
||||
setTag('url', url.toString());
|
||||
setContext('request', {
|
||||
method: request.method,
|
||||
url: url.toString(),
|
||||
rawRequestURL: request.url,
|
||||
userAgent: userAgent(),
|
||||
});
|
||||
|
||||
// Redirect to normalize the URL
|
||||
const normalized = normalizeURL(url);
|
||||
if (normalized.toString() !== url.toString()) {
|
||||
@@ -148,14 +139,6 @@ export async function middleware(request: NextRequest) {
|
||||
return writeCookies(NextResponse.redirect(normalizedVA.toString()), resolved.cookies);
|
||||
}
|
||||
|
||||
setTag('space', resolved.space);
|
||||
setContext('content', {
|
||||
space: resolved.space,
|
||||
changeRequest: resolved.changeRequest,
|
||||
revision: resolved.revision,
|
||||
...('site' in resolved ? { site: resolved.site, siteSpace: resolved.siteSpace } : {}),
|
||||
});
|
||||
|
||||
// Because of how Next will encode, we need to encode ourselves the pathname before rewriting to it.
|
||||
const rewritePathname = normalizePathname(encodePathname(resolved.pathname));
|
||||
|
||||
|
||||
@@ -1,9 +1,10 @@
|
||||
import { notFound } from 'next/navigation';
|
||||
import { notFound, redirect } from 'next/navigation';
|
||||
import { ImageResponse } from 'next/og';
|
||||
|
||||
import { getEmojiForCode } from '@/lib/emojis';
|
||||
import { tcls } from '@/lib/tailwind';
|
||||
import type { GitBookSiteContext } from '@v2/lib/context';
|
||||
import { getResizedImageURL } from '@v2/lib/images';
|
||||
|
||||
const SIZES = {
|
||||
/** Size for a favicon */
|
||||
@@ -25,11 +26,24 @@ const SIZES = {
|
||||
/**
|
||||
* Generate an icon for a site content.
|
||||
*/
|
||||
export function serveIcon(context: GitBookSiteContext, req: Request) {
|
||||
export async function serveIcon(context: GitBookSiteContext, req: Request) {
|
||||
const options = getOptions(req.url);
|
||||
const size = SIZES[options.size];
|
||||
|
||||
const { site, customization } = context;
|
||||
const customIcon = 'icon' in customization.favicon ? customization.favicon.icon : null;
|
||||
|
||||
// If the site has a custom icon, redirect to it
|
||||
if (customIcon) {
|
||||
const iconUrl = options.theme === 'light' ? customIcon.light : customIcon.dark;
|
||||
redirect(
|
||||
await getResizedImageURL(context.imageResizer, iconUrl, {
|
||||
width: size.width,
|
||||
height: size.height,
|
||||
})
|
||||
);
|
||||
}
|
||||
|
||||
const contentTitle = site.title;
|
||||
|
||||
return new ImageResponse(
|
||||
|
||||
@@ -7,6 +7,7 @@ import { type PageParams, fetchPageData } from '@/components/SitePage';
|
||||
import { getAssetURL } from '@/lib/assets';
|
||||
import { filterOutNullable } from '@/lib/typescript';
|
||||
import type { GitBookSiteContext } from '@v2/lib/context';
|
||||
import { getResizedImageURL } from '@v2/lib/images';
|
||||
|
||||
const googleFontsMap: { [fontName in CustomizationDefaultFont]: string } = {
|
||||
[CustomizationDefaultFont.Inter]: 'Inter',
|
||||
@@ -31,12 +32,17 @@ const googleFontsMap: { [fontName in CustomizationDefaultFont]: string } = {
|
||||
*/
|
||||
export async function serveOGImage(baseContext: GitBookSiteContext, params: PageParams) {
|
||||
const { context, pageTarget } = await fetchPageData(baseContext, params);
|
||||
const { customization, site, linker } = context;
|
||||
const { customization, site, linker, imageResizer } = context;
|
||||
const page = pageTarget?.page;
|
||||
|
||||
// If user configured a custom social preview, we redirect to it.
|
||||
if (customization.socialPreview.url) {
|
||||
redirect(customization.socialPreview.url);
|
||||
redirect(
|
||||
await getResizedImageURL(imageResizer, customization.socialPreview.url, {
|
||||
width: 1200,
|
||||
height: 630,
|
||||
})
|
||||
);
|
||||
}
|
||||
|
||||
// Compute all text to load only the necessary fonts
|
||||
|
||||
@@ -1,20 +0,0 @@
|
||||
import { init } from '@sentry/nextjs';
|
||||
|
||||
const dsn = process.env.SENTRY_DSN;
|
||||
if (dsn) {
|
||||
init({
|
||||
dsn,
|
||||
release: process.env.SENTRY_RELEASE,
|
||||
|
||||
// Disable tracing as it creates additional requests in an env where subrequests are limited.
|
||||
tracesSampleRate: 0,
|
||||
|
||||
// Disable transactions as it creates additional requests in an env where subrequests are limited.
|
||||
// https://docs.sentry.io/platforms/node/configuration/filtering/#using--3
|
||||
beforeSendTransaction: () => {
|
||||
return null;
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
export * from '@sentry/nextjs';
|
||||
@@ -77,7 +77,7 @@ const config: Config = {
|
||||
emoji: [
|
||||
'Apple Color Emoji',
|
||||
'Noto Color Emoji',
|
||||
'--font-noto-color-emoji',
|
||||
'var(--font-noto-color-emoji)',
|
||||
'sans-serif',
|
||||
],
|
||||
var: ['var(--font-family)'],
|
||||
@@ -456,8 +456,12 @@ const config: Config = {
|
||||
/**
|
||||
* Variant when a header is displayed.
|
||||
*/
|
||||
addVariant('site-header-none', 'html.site-header-none &');
|
||||
addVariant('site-header', 'body:has(#site-header:not(.mobile-only)) &');
|
||||
addVariant('site-header-sections', 'body:has(#site-header:not(.mobile-only) > nav) &');
|
||||
addVariant('site-header-sections', [
|
||||
'body:has(#site-header:not(.mobile-only) #sections) &',
|
||||
'body:has(.page-no-toc):has(#site-header:not(.mobile-only) #variants) &',
|
||||
]);
|
||||
|
||||
const customisationVariants = {
|
||||
// Sidebar styles
|
||||
@@ -502,12 +506,14 @@ const config: Config = {
|
||||
* Variant when the page contains a block that will be rendered in full-width mode.
|
||||
*/
|
||||
addVariant('page-full-width', 'body:has(.page-full-width) &');
|
||||
addVariant('page-default-width', 'body:has(.page-default-width) &');
|
||||
|
||||
/**
|
||||
* Variant when the page is configured to hide the table of content.
|
||||
* `page.layout.tableOfContents` is set to false.
|
||||
*/
|
||||
addVariant('page-no-toc', 'body:has(.page-no-toc) &');
|
||||
addVariant('page-has-toc', 'body:has(.page-has-toc) &');
|
||||
|
||||
/**
|
||||
* Variant when the page contains an OpenAPI block.
|
||||
|
||||
@@ -12,7 +12,7 @@
|
||||
"version": "2.1.0",
|
||||
"sideEffects": false,
|
||||
"dependencies": {
|
||||
"@scalar/openapi-parser": "^0.10.9",
|
||||
"@scalar/openapi-parser": "^0.10.10",
|
||||
"@scalar/openapi-types": "^0.1.9"
|
||||
},
|
||||
"devDependencies": {
|
||||
|
||||
@@ -1,60 +1,71 @@
|
||||
# @gitbook/react-contentkit
|
||||
|
||||
## 0.7.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- 6aaeae2: Fix an issue where ContentKit iframes were not resizing.
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 9108c56: Fix an issue where contentkit webframes weren't resized properly
|
||||
- c9ea239: Fix an issue where iframe aspect ratio was not respected.
|
||||
|
||||
## 0.6.2
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [88f64b0]
|
||||
- @gitbook/icons@0.2.0
|
||||
- Updated dependencies [88f64b0]
|
||||
- @gitbook/icons@0.2.0
|
||||
|
||||
## 0.6.1
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 8beb5d6: Add input elements to ContentKit
|
||||
- 8beb5d6: Add input elements to ContentKit
|
||||
|
||||
## 0.6.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- ea1468c: Send redirectOnError param to getPublishedContent when token is pulled from cookie
|
||||
- ea1468c: Send redirectOnError param to getPublishedContent when token is pulled from cookie
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 648f0e9: Fix potential invalid URL error in react-contentkit
|
||||
- 648f0e9: Fix potential invalid URL error in react-contentkit
|
||||
|
||||
## 0.5.1
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 0f1565c: Fix rendering of webframe with SSR causing wrong communication between frame and renderer
|
||||
- 0f1565c: Fix rendering of webframe with SSR causing wrong communication between frame and renderer
|
||||
|
||||
## 0.5.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- 3445db4: Fix files published in the NPM packages by defining "files" in "package.json"
|
||||
- 3445db4: Fix files published in the NPM packages by defining "files" in "package.json"
|
||||
|
||||
## 0.4.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- 24cd72e: Fix changeset CI workflow
|
||||
- 24cd72e: Fix changeset CI workflow
|
||||
|
||||
## 0.3.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- de747b7: Publish to NPM with JS files and TypeScript declaration files
|
||||
- de747b7: Publish to NPM with JS files and TypeScript declaration files
|
||||
|
||||
## 0.2.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- 57adb3e: Second release to fix publishing with changeset
|
||||
- 57adb3e: Second release to fix publishing with changeset
|
||||
|
||||
## 0.1.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- 5f8a8fe: Initial release
|
||||
- 5f8a8fe: Initial release
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@gitbook/react-contentkit",
|
||||
"version": "0.6.2",
|
||||
"version": "0.7.0",
|
||||
"exports": {
|
||||
".": {
|
||||
"types": "./dist/index.d.ts",
|
||||
|
||||
@@ -176,16 +176,10 @@ export function ElementWebframe(props: ContentKitClientElementProps<ContentKitWe
|
||||
allow="clipboard-write"
|
||||
className="contentkit-webframe"
|
||||
style={{
|
||||
// If given an aspect ratio, use width as auto dimension and let height take precedence.
|
||||
...(aspectRatio
|
||||
? {
|
||||
width: 'auto',
|
||||
aspectRatio,
|
||||
}
|
||||
: { width: '100%' }),
|
||||
|
||||
width: '100%',
|
||||
maxWidth: '100%',
|
||||
height: Math.max(size.height || 0, 32),
|
||||
aspectRatio,
|
||||
height: size.height ? Math.max(size.height, 32) : '100%',
|
||||
border: 'none',
|
||||
}}
|
||||
/>
|
||||
|
||||
@@ -1,203 +1,217 @@
|
||||
# @gitbook/react-openapi
|
||||
|
||||
## 1.1.5
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 886e204: Update OpenAPI operation path design
|
||||
|
||||
## 1.1.4
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- c60e9ba: Handle read-only in OpenAPISchemaName
|
||||
- 31d800e: Render OpenAPISchemas block
|
||||
- ff3b708: Remove read-only properties from codesample
|
||||
|
||||
## 1.1.3
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 844059f: Fix spacing in OpenAPISecurities
|
||||
- 844059f: Fix spacing in OpenAPISecurities
|
||||
|
||||
## 1.1.2
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- f127d28: Rename OpenAPIModels to OpenAPISchemas
|
||||
- f127d28: Rename OpenAPIModels to OpenAPISchemas
|
||||
|
||||
## 1.1.1
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- f574858: Fix OpenAPI example display error
|
||||
- f574858: Fix OpenAPI example display error
|
||||
|
||||
## 1.1.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- bb3ca9c: Implement OpenAPI models blocks
|
||||
- bb3ca9c: Implement OpenAPI models blocks
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 0278a14: Upgrade Scalar dependencies
|
||||
- 3173d8e: Remove top level circular refs in alternatives
|
||||
- Updated dependencies [0278a14]
|
||||
- Updated dependencies [bb3ca9c]
|
||||
- Updated dependencies [052e07a]
|
||||
- @gitbook/openapi-parser@2.1.0
|
||||
- 0278a14: Upgrade Scalar dependencies
|
||||
- 3173d8e: Remove top level circular refs in alternatives
|
||||
- Updated dependencies [0278a14]
|
||||
- Updated dependencies [bb3ca9c]
|
||||
- Updated dependencies [052e07a]
|
||||
- @gitbook/openapi-parser@2.1.0
|
||||
|
||||
## 1.0.5
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [53f5dbe]
|
||||
- @gitbook/openapi-parser@2.0.2
|
||||
- Updated dependencies [53f5dbe]
|
||||
- @gitbook/openapi-parser@2.0.2
|
||||
|
||||
## 1.0.4
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 722f02e: Fix recursion in OpenAPISchemaAlternative
|
||||
- Updated dependencies [0924259]
|
||||
- @gitbook/openapi-parser@2.0.1
|
||||
- 722f02e: Fix recursion in OpenAPISchemaAlternative
|
||||
- Updated dependencies [0924259]
|
||||
- @gitbook/openapi-parser@2.0.1
|
||||
|
||||
## 1.0.3
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- dc2dbc5: Update OpenAPI code examples to support multiple content-type
|
||||
- f1d1d2f: Return empty string if no server provided
|
||||
- 05e1d8c: Hide x-gitbook-\* symbols in OpenAPI blocks
|
||||
- b4a12d6: Fix circularRef in schema + examples OpenAPI
|
||||
- 9f0de74: Fix ID not set when there is no operation summary
|
||||
- da55fac: Render GitBook blocks in OpenAPI operation description
|
||||
- Updated dependencies [c808bb1]
|
||||
- Updated dependencies [e24206e]
|
||||
- Updated dependencies [a054554]
|
||||
- Updated dependencies [da55fac]
|
||||
- @gitbook/openapi-parser@2.0.0
|
||||
- dc2dbc5: Update OpenAPI code examples to support multiple content-type
|
||||
- f1d1d2f: Return empty string if no server provided
|
||||
- 05e1d8c: Hide x-gitbook-\* symbols in OpenAPI blocks
|
||||
- b4a12d6: Fix circularRef in schema + examples OpenAPI
|
||||
- 9f0de74: Fix ID not set when there is no operation summary
|
||||
- da55fac: Render GitBook blocks in OpenAPI operation description
|
||||
- Updated dependencies [c808bb1]
|
||||
- Updated dependencies [e24206e]
|
||||
- Updated dependencies [a054554]
|
||||
- Updated dependencies [da55fac]
|
||||
- @gitbook/openapi-parser@2.0.0
|
||||
|
||||
## 1.0.2
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- bb5c6a4: Support multiple response media types and examples
|
||||
- a3f1fea: Fix display of OpenAPI header description
|
||||
- 6157583: Improve Markdown parsing
|
||||
- 7419ee7: Show additional fields in OpenAPI block
|
||||
- 82cd9f2: Add support for anchor links in OpenAPI blocks
|
||||
- Updated dependencies [6157583]
|
||||
- @gitbook/openapi-parser@1.0.1
|
||||
- bb5c6a4: Support multiple response media types and examples
|
||||
- a3f1fea: Fix display of OpenAPI header description
|
||||
- 6157583: Improve Markdown parsing
|
||||
- 7419ee7: Show additional fields in OpenAPI block
|
||||
- 82cd9f2: Add support for anchor links in OpenAPI blocks
|
||||
- Updated dependencies [6157583]
|
||||
- @gitbook/openapi-parser@1.0.1
|
||||
|
||||
## 1.0.1
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- f8d4c76: Sync tabs across all OpenAPI blocks
|
||||
- dddb4ec: Fix long tab group description
|
||||
- f8d4c76: Support for OpenAPI references
|
||||
- f8d4c76: Sync tabs across all OpenAPI blocks
|
||||
- dddb4ec: Fix long tab group description
|
||||
- f8d4c76: Support for OpenAPI references
|
||||
|
||||
## 1.0.0
|
||||
|
||||
### Major Changes
|
||||
|
||||
- 727bde2: Improve and split OpenAPI parser into its own package
|
||||
- 12c7862: Use `@scalar/openapi-parser` to be more resilient and perf on OpenAPI spec parsing:
|
||||
- 727bde2: Improve and split OpenAPI parser into its own package
|
||||
- 12c7862: Use `@scalar/openapi-parser` to be more resilient and perf on OpenAPI spec parsing:
|
||||
|
||||
- `fetcher.fetch` must now returns a valid OpenAPI document
|
||||
- `parseOpenAPIV3` has been replaced by `parseOpenAPI`
|
||||
- `fetcher.fetch` must now returns a valid OpenAPI document
|
||||
- `parseOpenAPIV3` has been replaced by `parseOpenAPI`
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- 162b4b7: Add in HTTP example code blocks
|
||||
- e4e2f52: Add an optional client context to get a callback called when the Scalar client is opened for a block.
|
||||
- eb7c22f: Revert scalar to 1.0.87 to mitigate an issue with ApiClientModalProvider
|
||||
- 160fca1: new OpenAPI blocks design
|
||||
- e721f17: Use `@scalar/oas-utils` getExampleFromSchema to generate OpenAPI examples
|
||||
- fe8acc9: Fix an issue where a missing OpenAPI example would crash the page.
|
||||
- 1823101: Fix internal properties appearing in OpenAPI docs.
|
||||
- 162b4b7: Add in HTTP example code blocks
|
||||
- e4e2f52: Add an optional client context to get a callback called when the Scalar client is opened for a block.
|
||||
- eb7c22f: Revert scalar to 1.0.87 to mitigate an issue with ApiClientModalProvider
|
||||
- 160fca1: new OpenAPI blocks design
|
||||
- e721f17: Use `@scalar/oas-utils` getExampleFromSchema to generate OpenAPI examples
|
||||
- fe8acc9: Fix an issue where a missing OpenAPI example would crash the page.
|
||||
- 1823101: Fix internal properties appearing in OpenAPI docs.
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- d9029c7: Support apiKey in CodeSample security headers
|
||||
- 6e54a06: Support response examples
|
||||
- 0c03676: Better securities sample and headers
|
||||
- 3e5e458: Handle isArray schema type
|
||||
- 46edde9: Improve the OpenAPI package API
|
||||
- d9c8d57: Do not dereference before caching OpenAPI spec.
|
||||
- ccf2cff: Fix an issue where a response object using a special ref would crash the page.
|
||||
- dda0cc6: Flatten OpenAPI security object
|
||||
- f92e906: Prevent codemirror from loading multiple versions in scalar
|
||||
- dff08ae: Improve performances by loading Scalar API Client only when the button is clicked
|
||||
- fc7b16f: Updated scalar depdenency
|
||||
- a652958: Fix error on unresolvable refs by replacing with property name and any type
|
||||
- 2f73db7: Support non primitive examples in OpenAPI block
|
||||
- 160fca1: Support deprecated and x-deprecated-sunset in OpenAPI spec
|
||||
- b41d425: Improve OpenAPI rendering performances by caching markdown parsing
|
||||
- Updated dependencies [46edde9]
|
||||
- Updated dependencies [727bde2]
|
||||
- @gitbook/openapi-parser@1.0.0
|
||||
- d9029c7: Support apiKey in CodeSample security headers
|
||||
- 6e54a06: Support response examples
|
||||
- 0c03676: Better securities sample and headers
|
||||
- 3e5e458: Handle isArray schema type
|
||||
- 46edde9: Improve the OpenAPI package API
|
||||
- d9c8d57: Do not dereference before caching OpenAPI spec.
|
||||
- ccf2cff: Fix an issue where a response object using a special ref would crash the page.
|
||||
- dda0cc6: Flatten OpenAPI security object
|
||||
- f92e906: Prevent codemirror from loading multiple versions in scalar
|
||||
- dff08ae: Improve performances by loading Scalar API Client only when the button is clicked
|
||||
- fc7b16f: Updated scalar depdenency
|
||||
- a652958: Fix error on unresolvable refs by replacing with property name and any type
|
||||
- 2f73db7: Support non primitive examples in OpenAPI block
|
||||
- 160fca1: Support deprecated and x-deprecated-sunset in OpenAPI spec
|
||||
- b41d425: Improve OpenAPI rendering performances by caching markdown parsing
|
||||
- Updated dependencies [46edde9]
|
||||
- Updated dependencies [727bde2]
|
||||
- @gitbook/openapi-parser@1.0.0
|
||||
|
||||
## 0.7.1
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 4771c78: Fixed scalar api client routing
|
||||
- ff50ac2: Bump @scalar/api-client-react version
|
||||
- 867481c: Support Integers in Response example
|
||||
- 7ba67fd: bumped the scalar api client dependency
|
||||
- a78c1ec: Bumped scalar api client pacakge
|
||||
- 4771c78: Fixed scalar api client routing
|
||||
- ff50ac2: Bump @scalar/api-client-react version
|
||||
- 867481c: Support Integers in Response example
|
||||
- 7ba67fd: bumped the scalar api client dependency
|
||||
- a78c1ec: Bumped scalar api client pacakge
|
||||
|
||||
## 0.7.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- cf3045a: Add Python support in Code Samples
|
||||
- 4247361: Add required query parameters to the code sample
|
||||
- aa8c49e: Display pattern if available in parmas in OpenAPI block
|
||||
- e914903: Synchronize response and response example tabs
|
||||
- 4cbcc5b: Rollback of scalar modal while fixing perf issue
|
||||
- cf3045a: Add Python support in Code Samples
|
||||
- 4247361: Add required query parameters to the code sample
|
||||
- aa8c49e: Display pattern if available in parmas in OpenAPI block
|
||||
- e914903: Synchronize response and response example tabs
|
||||
- 4cbcc5b: Rollback of scalar modal while fixing perf issue
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 51fa3ab: Adds content-visibility css property to OpenAPI Operation for better render performance
|
||||
- f89b31c: Upgrade the scalar api client package
|
||||
- 094e9cd: bump: scalar from 1.0.5 to 1.0.7
|
||||
- 237b703: Fix crash when `example` is undefined for a response
|
||||
- 51955da: Adds tabs to Response Example section e.g. for status code examples
|
||||
- a679e72: Render mandatory headers in code sample
|
||||
- c079c3c: Update Scalar client to latest version
|
||||
- 51fa3ab: Adds content-visibility css property to OpenAPI Operation for better render performance
|
||||
- f89b31c: Upgrade the scalar api client package
|
||||
- 094e9cd: bump: scalar from 1.0.5 to 1.0.7
|
||||
- 237b703: Fix crash when `example` is undefined for a response
|
||||
- 51955da: Adds tabs to Response Example section e.g. for status code examples
|
||||
- a679e72: Render mandatory headers in code sample
|
||||
- c079c3c: Update Scalar client to latest version
|
||||
|
||||
## 0.6.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- 709f1a1: Update Scalar to the latest version, with faster performances and an improved experience
|
||||
- 709f1a1: Update Scalar to the latest version, with faster performances and an improved experience
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- ede2335: Fix x-codeSamples: false not working at the single operation level
|
||||
- 0426312: Fix tabs being empty for code samples when they are updated dynamically
|
||||
- ede2335: Fix x-codeSamples: false not working at the single operation level
|
||||
- 0426312: Fix tabs being empty for code samples when they are updated dynamically
|
||||
|
||||
## 0.5.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- 3445db4: Fix files published in the NPM packages by defining "files" in "package.json"
|
||||
- 3445db4: Fix files published in the NPM packages by defining "files" in "package.json"
|
||||
|
||||
## 0.4.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- 24cd72e: Fix changeset CI workflow
|
||||
- 24cd72e: Fix changeset CI workflow
|
||||
|
||||
## 0.3.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- de747b7: Refactor the repository to be a proper monorepo and publish JS files on NPM instead of TypeScript files.
|
||||
- de747b7: Refactor the repository to be a proper monorepo and publish JS files on NPM instead of TypeScript files.
|
||||
|
||||
## 0.3.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- bd0ca5b: Fix missing react imports
|
||||
- bd0ca5b: Fix missing react imports
|
||||
|
||||
## 0.2.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- 57adb3e: Second release to fix publishing with changeset
|
||||
- 57adb3e: Second release to fix publishing with changeset
|
||||
|
||||
## 0.1.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- 5f8a8fe: Initial release
|
||||
- 5f8a8fe: Initial release
|
||||
|
||||
@@ -8,12 +8,12 @@
|
||||
"default": "./dist/index.js"
|
||||
}
|
||||
},
|
||||
"version": "1.1.3",
|
||||
"version": "1.1.5",
|
||||
"sideEffects": false,
|
||||
"dependencies": {
|
||||
"@gitbook/openapi-parser": "workspace:*",
|
||||
"@scalar/api-client-react": "^1.1.36",
|
||||
"@scalar/oas-utils": "^0.2.110",
|
||||
"@scalar/api-client-react": "^1.2.5",
|
||||
"@scalar/oas-utils": "^0.2.120",
|
||||
"clsx": "^2.1.1",
|
||||
"flatted": "^3.2.9",
|
||||
"json-xml-parse": "^1.3.0",
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
import type { OpenAPIV3 } from '@gitbook/openapi-parser';
|
||||
import { OpenAPITabs, OpenAPITabsList, OpenAPITabsPanels } from './OpenAPITabs';
|
||||
import { ScalarApiButton } from './ScalarApiButton';
|
||||
import { StaticSection } from './StaticSection';
|
||||
import { type CodeSampleInput, codeSampleGenerators } from './code-samples';
|
||||
import { generateMediaTypeExample, generateSchemaExample } from './generateSchemaExample';
|
||||
@@ -79,6 +81,7 @@ export function OpenAPICodeSample(props: {
|
||||
code: generator.generate(input),
|
||||
syntax: generator.syntax,
|
||||
}),
|
||||
footer: <OpenAPICodeSampleFooter data={data} context={context} />,
|
||||
}));
|
||||
|
||||
// Use custom samples if defined
|
||||
@@ -105,6 +108,7 @@ export function OpenAPICodeSample(props: {
|
||||
code: sample.source,
|
||||
syntax: sample.lang,
|
||||
}),
|
||||
footer: <OpenAPICodeSampleFooter data={data} context={context} />,
|
||||
}));
|
||||
}
|
||||
});
|
||||
@@ -128,6 +132,30 @@ export function OpenAPICodeSample(props: {
|
||||
);
|
||||
}
|
||||
|
||||
function OpenAPICodeSampleFooter(props: {
|
||||
data: OpenAPIOperationData;
|
||||
context: OpenAPIContextProps;
|
||||
}) {
|
||||
const { data, context } = props;
|
||||
const { method, path } = data;
|
||||
const { specUrl } = context;
|
||||
const hideTryItPanel = data['x-hideTryItPanel'] || data.operation['x-hideTryItPanel'];
|
||||
|
||||
if (hideTryItPanel) {
|
||||
return null;
|
||||
}
|
||||
|
||||
if (!validateHttpMethod(method)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return (
|
||||
<div className="openapi-codesample-footer">
|
||||
<ScalarApiButton method={method} path={path} specUrl={specUrl} />
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
function getSecurityHeaders(securities: OpenAPIOperationData['securities']): {
|
||||
[key: string]: string;
|
||||
} {
|
||||
@@ -169,3 +197,7 @@ function getSecurityHeaders(securities: OpenAPIOperationData['securities']): {
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
function validateHttpMethod(method: string): method is OpenAPIV3.HttpMethods {
|
||||
return ['get', 'post', 'put', 'delete', 'patch', 'head', 'options', 'trace'].includes(method);
|
||||
}
|
||||
|
||||
@@ -0,0 +1,54 @@
|
||||
'use client';
|
||||
|
||||
import { useState } from 'react';
|
||||
import { Button, type ButtonProps, Tooltip, TooltipTrigger } from 'react-aria-components';
|
||||
|
||||
export function OpenAPICopyButton(
|
||||
props: ButtonProps & {
|
||||
value: string;
|
||||
}
|
||||
) {
|
||||
const { value } = props;
|
||||
const { children, onPress, className } = props;
|
||||
const [copied, setCopied] = useState(false);
|
||||
const [isOpen, setIsOpen] = useState(false);
|
||||
|
||||
const handleCopy = () => {
|
||||
if (!value) return;
|
||||
navigator.clipboard.writeText(value).then(() => {
|
||||
setIsOpen(true);
|
||||
setCopied(true);
|
||||
|
||||
setTimeout(() => {
|
||||
setCopied(false);
|
||||
}, 2000);
|
||||
});
|
||||
};
|
||||
|
||||
return (
|
||||
<TooltipTrigger isOpen={isOpen} onOpenChange={setIsOpen} closeDelay={200} delay={200}>
|
||||
<Button
|
||||
type="button"
|
||||
preventFocusOnPress
|
||||
onPress={(e) => {
|
||||
handleCopy();
|
||||
onPress?.(e);
|
||||
}}
|
||||
className={`openapi-copy-button ${className}`}
|
||||
{...props}
|
||||
>
|
||||
{children}
|
||||
</Button>
|
||||
|
||||
<Tooltip
|
||||
isOpen={isOpen}
|
||||
onOpenChange={setIsOpen}
|
||||
placement="top"
|
||||
offset={4}
|
||||
className="openapi-tooltip"
|
||||
>
|
||||
{copied ? 'Copied' : 'Copy to clipboard'}{' '}
|
||||
</Tooltip>
|
||||
</TooltipTrigger>
|
||||
);
|
||||
}
|
||||
@@ -35,6 +35,7 @@ export function OpenAPIOperation(props: {
|
||||
title: operation.summary,
|
||||
})
|
||||
: null}
|
||||
<OpenAPIPath data={data} context={context} />
|
||||
{operation.deprecated && <div className="openapi-deprecated">Deprecated</div>}
|
||||
</div>
|
||||
<div className="openapi-columns">
|
||||
@@ -49,7 +50,6 @@ export function OpenAPIOperation(props: {
|
||||
</div>
|
||||
) : null}
|
||||
<OpenAPIOperationDescription operation={operation} context={context} />
|
||||
<OpenAPIPath data={data} context={context} />
|
||||
<OpenAPISpec data={data} context={clientContext} />
|
||||
</div>
|
||||
<div className="openapi-column-preview">
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
import type { OpenAPIV3_1 } from '@gitbook/openapi-parser';
|
||||
import type React from 'react';
|
||||
import { ScalarApiButton } from './ScalarApiButton';
|
||||
import { OpenAPICopyButton } from './OpenAPICopyButton';
|
||||
import type { OpenAPIContextProps, OpenAPIOperationData } from './types';
|
||||
import { getDefaultServerURL } from './util/server';
|
||||
|
||||
/**
|
||||
* Display the path of an operation.
|
||||
@@ -10,63 +9,62 @@ export function OpenAPIPath(props: {
|
||||
data: OpenAPIOperationData;
|
||||
context: OpenAPIContextProps;
|
||||
}) {
|
||||
const { data, context } = props;
|
||||
const { method, path } = data;
|
||||
const { specUrl } = context;
|
||||
const hideTryItPanel = data['x-hideTryItPanel'] || data.operation['x-hideTryItPanel'];
|
||||
const { data } = props;
|
||||
const { method, path, operation } = data;
|
||||
|
||||
const server = getDefaultServerURL(data.servers);
|
||||
const formattedPath = formatPath(path);
|
||||
|
||||
return (
|
||||
<div className="openapi-path">
|
||||
<div className={`openapi-method openapi-method-${method}`}>{method}</div>
|
||||
<div className="openapi-path-title" data-deprecated={data.operation.deprecated}>
|
||||
<p>{formatPath(path)}</p>
|
||||
</div>
|
||||
{!hideTryItPanel && validateHttpMethod(method) && (
|
||||
<ScalarApiButton method={method} path={path} specUrl={specUrl} />
|
||||
)}
|
||||
|
||||
<OpenAPICopyButton
|
||||
value={server + path}
|
||||
className="openapi-path-title"
|
||||
data-deprecated={operation.deprecated}
|
||||
>
|
||||
<span className="openapi-path-server">{server}</span>
|
||||
{formattedPath}
|
||||
</OpenAPICopyButton>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
function validateHttpMethod(method: string): method is OpenAPIV3_1.HttpMethods {
|
||||
return ['get', 'post', 'put', 'delete', 'patch', 'head', 'options', 'trace'].includes(method);
|
||||
}
|
||||
|
||||
// Format the path to highlight placeholders
|
||||
/**
|
||||
* Format the path by wrapping placeholders in <span> tags.
|
||||
*/
|
||||
function formatPath(path: string) {
|
||||
// Matches placeholders like {id}, {userId}, etc.
|
||||
const regex = /\{(\w+)\}/g;
|
||||
const regex = /\{\s*(\w+)\s*\}|:\w+/g;
|
||||
|
||||
const parts: (string | React.JSX.Element)[] = [];
|
||||
let lastIndex = 0;
|
||||
|
||||
// Replace placeholders with <em> tags
|
||||
path.replace(regex, (match, key, offset) => {
|
||||
parts.push(path.slice(lastIndex, offset));
|
||||
parts.push(<em key={key}>{`{${key}}`}</em>);
|
||||
//Wrap the variables in <span> tags and maintain either {variable} or :variable
|
||||
path.replace(regex, (match, _, offset) => {
|
||||
if (offset > lastIndex) {
|
||||
parts.push(path.slice(lastIndex, offset));
|
||||
}
|
||||
parts.push(
|
||||
<span key={offset} className="openapi-path-variable">
|
||||
{match}
|
||||
</span>
|
||||
);
|
||||
lastIndex = offset + match.length;
|
||||
return match;
|
||||
});
|
||||
|
||||
// Push remaining text after the last placeholder
|
||||
parts.push(path.slice(lastIndex));
|
||||
if (lastIndex < path.length) {
|
||||
parts.push(path.slice(lastIndex));
|
||||
}
|
||||
|
||||
// Join parts with separators wrapped in <span>
|
||||
const formattedPath = parts.reduce(
|
||||
(acc, part, index) => {
|
||||
if (typeof part === 'string' && index > 0 && part === '/') {
|
||||
acc.push(
|
||||
<span className="openapi-path-separator" key={`sep-${index}`}>
|
||||
/
|
||||
</span>
|
||||
);
|
||||
}
|
||||
const formattedPath = parts.map((part, index) => {
|
||||
if (typeof part === 'string') {
|
||||
return <span key={index}>{part}</span>;
|
||||
}
|
||||
return part;
|
||||
});
|
||||
|
||||
acc.push(part);
|
||||
return acc;
|
||||
},
|
||||
[] as (string | React.JSX.Element)[]
|
||||
);
|
||||
|
||||
return <span>{formattedPath}</span>;
|
||||
return formattedPath;
|
||||
}
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
import type { OpenAPIV3 } from '@gitbook/openapi-parser';
|
||||
import { Markdown } from './Markdown';
|
||||
import { OpenAPITabs, OpenAPITabsList, OpenAPITabsPanels } from './OpenAPITabs';
|
||||
import { StaticSection } from './StaticSection';
|
||||
import { generateSchemaExample } from './generateSchemaExample';
|
||||
@@ -39,44 +40,40 @@ export function OpenAPIResponseExample(props: {
|
||||
return Number(a) - Number(b);
|
||||
});
|
||||
|
||||
const tabs = responses
|
||||
.map(([key, responseObject]) => {
|
||||
const description = resolveDescription(responseObject);
|
||||
|
||||
if (checkIsReference(responseObject)) {
|
||||
return {
|
||||
key: key,
|
||||
label: key,
|
||||
description,
|
||||
body: (
|
||||
<OpenAPIExample
|
||||
example={getExampleFromReference(responseObject)}
|
||||
context={context}
|
||||
syntax="json"
|
||||
/>
|
||||
),
|
||||
};
|
||||
}
|
||||
|
||||
if (!responseObject.content || Object.keys(responseObject.content).length === 0) {
|
||||
return {
|
||||
key: key,
|
||||
label: key,
|
||||
description,
|
||||
body: <OpenAPIEmptyResponseExample />,
|
||||
};
|
||||
}
|
||||
const tabs = responses.map(([key, responseObject]) => {
|
||||
const description = resolveDescription(responseObject);
|
||||
|
||||
if (checkIsReference(responseObject)) {
|
||||
return {
|
||||
key: key,
|
||||
label: key,
|
||||
description: resolveDescription(responseObject),
|
||||
body: <OpenAPIResponse context={context} content={responseObject.content} />,
|
||||
body: (
|
||||
<OpenAPIExample
|
||||
example={getExampleFromReference(responseObject)}
|
||||
context={context}
|
||||
syntax="json"
|
||||
/>
|
||||
),
|
||||
footer: description ? <Markdown source={description} /> : undefined,
|
||||
};
|
||||
})
|
||||
.filter((val): val is { key: string; label: string; body: any; description: string } =>
|
||||
Boolean(val)
|
||||
);
|
||||
}
|
||||
|
||||
if (!responseObject.content || Object.keys(responseObject.content).length === 0) {
|
||||
return {
|
||||
key: key,
|
||||
label: key,
|
||||
body: <OpenAPIEmptyResponseExample />,
|
||||
footer: description ? <Markdown source={description} /> : undefined,
|
||||
};
|
||||
}
|
||||
|
||||
return {
|
||||
key: key,
|
||||
label: key,
|
||||
body: <OpenAPIResponse context={context} content={responseObject.content} />,
|
||||
footer: description ? <Markdown source={description} /> : undefined,
|
||||
};
|
||||
});
|
||||
|
||||
if (tabs.length === 0) {
|
||||
return null;
|
||||
|
||||
@@ -3,14 +3,13 @@
|
||||
import { createContext, useContext, useEffect, useMemo, useRef, useState } from 'react';
|
||||
import { type Key, Tab, TabList, TabPanel, Tabs, type TabsProps } from 'react-aria-components';
|
||||
import { useEventCallback } from 'usehooks-ts';
|
||||
import { Markdown } from './Markdown';
|
||||
import { getOrCreateTabStoreByKey } from './useSyncedTabsGlobalState';
|
||||
|
||||
export type TabItem = {
|
||||
key: Key;
|
||||
label: string;
|
||||
body: React.ReactNode;
|
||||
description?: string;
|
||||
footer?: React.ReactNode;
|
||||
};
|
||||
|
||||
type OpenAPITabsContextData = {
|
||||
@@ -140,9 +139,19 @@ export function OpenAPITabsPanels() {
|
||||
return (
|
||||
<TabPanel key={key} id={key} className="openapi-tabs-panel">
|
||||
{selectedTab.body}
|
||||
{selectedTab.description ? (
|
||||
<Markdown source={selectedTab.description} className="openapi-tabs-footer" />
|
||||
{selectedTab.footer ? (
|
||||
<OpenAPITabsPanelFooter>{selectedTab.footer}</OpenAPITabsPanelFooter>
|
||||
) : null}
|
||||
</TabPanel>
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* The OpenAPI Tabs panel footer component.
|
||||
* This component should be used as a child of the OpenAPITabs component.
|
||||
*/
|
||||
function OpenAPITabsPanelFooter(props: { children: React.ReactNode }) {
|
||||
const { children } = props;
|
||||
|
||||
return <div className="openapi-tabs-footer">{children}</div>;
|
||||
}
|
||||
|
||||
@@ -27,14 +27,14 @@ export function ScalarApiButton(props: {
|
||||
setIsOpen(true);
|
||||
}}
|
||||
>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="10" height="12" fill="none">
|
||||
Test it
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 10 12" fill="currentColor">
|
||||
<path
|
||||
stroke="currentColor"
|
||||
strokeWidth="1.5"
|
||||
d="M1 10.05V1.43c0-.2.2-.31.37-.22l7.26 4.08c.17.1.17.33.01.43l-7.26 4.54a.25.25 0 0 1-.38-.21Z"
|
||||
/>
|
||||
</svg>
|
||||
Test it
|
||||
</button>
|
||||
|
||||
{isOpen &&
|
||||
|
||||
@@ -4,13 +4,18 @@ import { OpenAPIRootSchema } from '../OpenAPISchema';
|
||||
import { Section, SectionBody } from '../StaticSection';
|
||||
import type { OpenAPIClientContext, OpenAPIContextProps, OpenAPISchemasData } from '../types';
|
||||
|
||||
type OpenAPISchemasContextProps = Omit<
|
||||
OpenAPIContextProps,
|
||||
'renderCodeBlock' | 'renderHeading' | 'renderDocument'
|
||||
>;
|
||||
|
||||
/**
|
||||
* Display OpenAPI Schemas.
|
||||
*/
|
||||
export function OpenAPISchemas(props: {
|
||||
className?: string;
|
||||
data: OpenAPISchemasData;
|
||||
context: OpenAPIContextProps;
|
||||
context: OpenAPISchemasContextProps;
|
||||
}) {
|
||||
const { className, data, context } = props;
|
||||
const { schemas } = data;
|
||||
|
||||
@@ -0,0 +1,174 @@
|
||||
import { describe, expect, it } from 'bun:test';
|
||||
|
||||
import { parseOpenAPI, traverse } from '@gitbook/openapi-parser';
|
||||
import { resolveOpenAPISchemas } from './resolveOpenAPISchemas';
|
||||
|
||||
async function fetchFilesystem(url: string) {
|
||||
const response = await fetch(url);
|
||||
const text = await response.text();
|
||||
const filesystem = await parseOpenAPI({ value: text, rootURL: url });
|
||||
const transformedFs = await traverse(filesystem, async (node) => {
|
||||
if ('description' in node && typeof node.description === 'string' && node.description) {
|
||||
node['x-gitbook-description-html'] = node.description;
|
||||
}
|
||||
return node;
|
||||
});
|
||||
return transformedFs;
|
||||
}
|
||||
|
||||
describe('#resolveOpenAPISchemas', () => {
|
||||
it('should resolve refs', async () => {
|
||||
const filesystem = await fetchFilesystem(
|
||||
'https://petstore3.swagger.io/api/v3/openapi.json'
|
||||
);
|
||||
const resolved = await resolveOpenAPISchemas(filesystem, { schemas: ['Pet', 'Tag'] });
|
||||
|
||||
expect(resolved).toMatchObject({
|
||||
schemas: [
|
||||
{
|
||||
name: 'Pet',
|
||||
schema: {
|
||||
properties: {
|
||||
tags: {
|
||||
type: 'array',
|
||||
items: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
id: {
|
||||
format: 'int64',
|
||||
type: 'integer',
|
||||
},
|
||||
name: {
|
||||
type: 'string',
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
name: 'Tag',
|
||||
schema: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
id: {
|
||||
type: 'integer',
|
||||
format: 'int64',
|
||||
},
|
||||
name: {
|
||||
type: 'string',
|
||||
},
|
||||
},
|
||||
xml: {
|
||||
name: 'tag',
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
});
|
||||
});
|
||||
|
||||
it('should support yaml', async () => {
|
||||
const filesystem = await fetchFilesystem(
|
||||
'https://petstore3.swagger.io/api/v3/openapi.yaml'
|
||||
);
|
||||
const resolved = await resolveOpenAPISchemas(filesystem, { schemas: ['Pet'] });
|
||||
|
||||
expect(resolved).toMatchObject({
|
||||
schemas: [
|
||||
{
|
||||
name: 'Pet',
|
||||
schema: {
|
||||
properties: {
|
||||
tags: {
|
||||
type: 'array',
|
||||
items: {
|
||||
properties: {
|
||||
id: {
|
||||
format: 'int64',
|
||||
type: 'integer',
|
||||
},
|
||||
name: {
|
||||
type: 'string',
|
||||
},
|
||||
},
|
||||
type: 'object',
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
});
|
||||
});
|
||||
|
||||
it('should resolve circular refs', async () => {
|
||||
const filesystem = await fetchFilesystem('https://api.gitbook.com/openapi.json');
|
||||
const resolved = await resolveOpenAPISchemas(filesystem, {
|
||||
schemas: ['DocumentBlockTabs'],
|
||||
});
|
||||
|
||||
expect(resolved).toMatchObject({
|
||||
schemas: [
|
||||
{
|
||||
name: 'DocumentBlockTabs',
|
||||
schema: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
object: {
|
||||
type: 'string',
|
||||
enum: ['block'],
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
});
|
||||
});
|
||||
|
||||
it('should resolve to null if the schema does not exist', async () => {
|
||||
const filesystem = await fetchFilesystem(
|
||||
'https://petstore3.swagger.io/api/v3/openapi.json'
|
||||
);
|
||||
const resolved = await resolveOpenAPISchemas(filesystem, {
|
||||
schemas: ['NonExistentSchema'],
|
||||
});
|
||||
|
||||
expect(resolved).toBe(null);
|
||||
});
|
||||
|
||||
it('should parse Swagger 2.0', async () => {
|
||||
const filesystem = await fetchFilesystem('https://petstore.swagger.io/v2/swagger.json');
|
||||
const resolved = await resolveOpenAPISchemas(filesystem, {
|
||||
schemas: ['Pet'],
|
||||
});
|
||||
|
||||
expect(resolved).toMatchObject({
|
||||
schemas: [
|
||||
{
|
||||
name: 'Pet',
|
||||
schema: {
|
||||
properties: {
|
||||
tags: {
|
||||
type: 'array',
|
||||
items: {
|
||||
properties: {
|
||||
id: {
|
||||
format: 'int64',
|
||||
type: 'integer',
|
||||
},
|
||||
name: {
|
||||
type: 'string',
|
||||
},
|
||||
},
|
||||
type: 'object',
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -15,21 +15,43 @@ import type { OpenAPISchema, OpenAPISchemasData } from '../types';
|
||||
* Schemas are extracted from the OpenAPI components.schemas
|
||||
*/
|
||||
export async function resolveOpenAPISchemas(
|
||||
filesystem: Filesystem<OpenAPIV3xDocument>
|
||||
filesystem: Filesystem<OpenAPIV3xDocument>,
|
||||
options: {
|
||||
schemas: string[];
|
||||
}
|
||||
): Promise<OpenAPISchemasData | null> {
|
||||
const { schemas: selectedSchemas } = options;
|
||||
|
||||
const schema = await dereferenceFilesystem(filesystem);
|
||||
|
||||
const schemas = getOpenAPIComponents(schema);
|
||||
const schemas = filterSelectedOpenAPISchemas(schema, selectedSchemas);
|
||||
|
||||
if (schemas.length === 0) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return { schemas };
|
||||
}
|
||||
|
||||
/**
|
||||
* Get OpenAPI components.schemas that are not ignored.
|
||||
* Extract selected schemas from the OpenAPI document.
|
||||
*/
|
||||
function getOpenAPIComponents(schema: OpenAPIV3.Document | OpenAPIV3_1.Document): OpenAPISchema[] {
|
||||
const schemas = schema.components?.schemas ?? {};
|
||||
return Object.entries(schemas)
|
||||
.filter(([, schema]) => !shouldIgnoreEntity(schema))
|
||||
.map(([key, schema]) => ({ name: key, schema }));
|
||||
export function filterSelectedOpenAPISchemas(
|
||||
schema: OpenAPIV3.Document | OpenAPIV3_1.Document,
|
||||
selectedSchemas: string[]
|
||||
): OpenAPISchema[] {
|
||||
const componentsSchemas = schema.components?.schemas ?? {};
|
||||
|
||||
// Preserve the order of the selected schemas
|
||||
return selectedSchemas
|
||||
.map((name) => {
|
||||
const schema = componentsSchemas[name];
|
||||
if (schema && !shouldIgnoreEntity(schema)) {
|
||||
return {
|
||||
name,
|
||||
schema,
|
||||
};
|
||||
}
|
||||
return null;
|
||||
})
|
||||
.filter((schema): schema is OpenAPISchema => !!schema);
|
||||
}
|
||||
|
||||
@@ -7,7 +7,6 @@
|
||||
"ARGOS_*",
|
||||
"GITHUB_*",
|
||||
"GITBOOK_*",
|
||||
"SENTRY_*",
|
||||
"NEXT_SERVER_ACTIONS_ENCRYPTION_KEY"
|
||||
],
|
||||
"tasks": {
|
||||
|
||||
Reference in New Issue
Block a user