Compare commits

..

1 Commits

Author SHA1 Message Date
Samy Pessé 0a4c3a98ea Set cache-control to no-cache for adaptive content 2024-12-20 23:22:22 +01:00
313 changed files with 3528 additions and 65631 deletions
+1 -1
View File
@@ -1 +1 @@
1.2.1
1.1.40
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Fix UI search without ask AI enabled and fix error with questions not returned from API
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Fix empty sitemap
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Support llms.txt
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Add support for keyboard marks
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Fix search no results error showing while there are results
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Log component stack in Sentry
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': minor
---
Reintroduce a safety check around search whilst we continue investigating caching.
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': minor
---
Track new events for site insights when ads are being clicked
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Apply antialiasing on any text that are not code inline/blocks to avoid contrast issues
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Handle security issue with cookies on Safari
-5
View File
@@ -1,5 +0,0 @@
---
'@gitbook/react-openapi': minor
---
Add in HTTP example code blocks
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': minor
---
Investigate an issue causing caches to return empty objects instead of null/undefined.
-5
View File
@@ -1,5 +0,0 @@
---
'@gitbook/react-openapi': minor
---
Add an optional client context to get a callback called when the Scalar client is opened for a block.
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Fix vertical section overflow color
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Reduce gap between subsequent header buttons
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Fix pass Sentry release properly
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Fix shrinking page icons
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': minor
---
Add support for sidebar background styles
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Start using tint in more places, TOC and PageAside
-7
View File
@@ -1,7 +0,0 @@
---
'gitbook': patch
---
Ignore invalid API calls to `getSiteRedirectFromSource` API
To reduce the load on the API and also avoid errors.
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Remove KV cache backend and only rely on DO as an external cache backend
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Fix default outline list styling
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Ignore errors from event flushing
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Simplify search results logic to investigate a bug
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Cache API spec for 24 hours, revalidated every 2 hours
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Try to fix error on og image generation
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Improve emoji setup, align with GitBook app
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Downgrade to Next.js v14 to fix incompatibilities with next-on-pages causing multiple bugs.
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': minor
---
Fix an issue where the redirects of potentially malicious images were not going through.
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Fix zoom image view transition on Safari
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Position the variant picker in the ToC
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Update footer styling and allow for more than 4 footer groups
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Make cookies access safer
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Fix Image blocks zoomable behaviour
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Handle Firefox security error on localStorage
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Fix errors from customization not found
-6
View File
@@ -1,6 +0,0 @@
---
'@gitbook/react-openapi': patch
'gitbook': patch
---
Do not dereference before caching OpenAPI spec.
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Fix regression issue with page icons for multi-line titles
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Fix OG image generation for non-latin characters
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Simplify the `useHash` algo used.
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Ignore cache invalidation error from local backend
-5
View File
@@ -1,5 +0,0 @@
---
'@gitbook/react-openapi': patch
---
Fix an issue where a response object using a special ref would crash the page.
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Allow only good values for theme query parameter. Avoid having a 500 error when we pass an invalid value.
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Set Sentry release
-6
View File
@@ -1,6 +0,0 @@
---
'@gitbook/react-openapi': minor
'gitbook': minor
---
Revert scalar to 1.0.87 to mitigate an issue with ApiClientModalProvider
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': minor
---
Restyle PageAside to use sidebar list styles
-5
View File
@@ -1,5 +0,0 @@
---
'@gitbook/react-contentkit': patch
---
Fix potential invalid URL error in react-contentkit
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Avoid error on fetch by passing a string URL
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Generate sitemap for all sections and spaces
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': minor
---
Fix an issue where search and Ask AI triggers unnecessary renders when in a Visitor Authenticated site.
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': minor
---
Track clicks on links (header, footer, content) for site insights.
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Add feedback form to page rating control
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Update the routes for changes/revisions in multi-id mode to match the normal mode
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Fix code format overriding inline link styles
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Fix server actions stability leading to no results found sometimes on search
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Lazy load iframely script to make page more responsive
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Cards stand out slighly more on tinted and dark mode sites, and have better support for headings inside them
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
New highlight colors
-7
View File
@@ -1,7 +0,0 @@
---
'gitbook': patch
---
Implement a safer way to interact with localStorage.
If it's disabled on the browser it should not throw error.
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Fix search UI behaviour
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Fix two issues where pages would crash due Recoil not behaving correctly in RSC.
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Fix dynamic tabs infinite loop
-5
View File
@@ -1,5 +0,0 @@
---
'@gitbook/react-openapi': patch
---
Prevent codemirror from loading multiple versions in scalar
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Fix error when accessing a change request not found
-5
View File
@@ -1,5 +0,0 @@
---
'@gitbook/react-openapi': patch
---
Improve performances by loading Scalar API Client only when the button is clicked
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Fix issue leading to increase the storage write and the stability of the platform
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Force route handler to be dynamic to avoid errors
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Fix search loading state
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Disable C/C++ highlight temporarily
-6
View File
@@ -1,6 +0,0 @@
---
'@gitbook/react-openapi': minor
'gitbook': minor
---
Fix internal properties appearing in OpenAPI docs.
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Fix Sentry instrumentation
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Even safer localStorage
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Avoid errors on legacy browsers
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': minor
---
Add antialiasing for text rendering
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': minor
---
Improve readability of tables with hover style and vertical dividers
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Improve styling of header buttons with shadows and high-contrast styles
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Fix viewing PDF from space
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': minor
---
Image optimization endpoint redirects to underlying image URL if the signature is not the latest.
-8
View File
@@ -1,8 +0,0 @@
---
'@gitbook/react-openapi': major
---
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`
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Vertical orientation for sections list on sites without header
-6
View File
@@ -1,6 +0,0 @@
---
'@gitbook/react-openapi': patch
'gitbook': patch
---
Improve OpenAPI rendering performances by caching markdown parsing
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Improve performances by highlighting code client-side if the code block is offscreen
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Fix error when accessing some not found pages.
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Fix "Parser" language syntax highlighting
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': minor
---
Fix a vulnerability issue for images using an older version of the image signing parameter.
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': minor
---
Track an event into site insights when visitor is opening the Scalar API client.
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Upgrade Next.js to v15, upgrade Shiki and use JS RegExp engine
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Fix breadcrumbs emoji display + add contrast styles
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Fix server actions cache compromised. Leading to some bugs on frontend.
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Improve smoothness of scroll listener
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Fix variant dropdown styling in header
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Fix view transition error on Safari
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Bump `heading-3` font size to offset it from paragraphs
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Fix Sentry instrumentation server-side
-5
View File
@@ -1,5 +0,0 @@
---
'gitbook': patch
---
Remove animation on section tabs. Page is reloaded (for technical reasons), so the animation is not accurate here.
-2
View File
@@ -41,11 +41,9 @@ jobs:
run: bun run 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.11.0
+1 -1
View File
@@ -1 +1 @@
v20.8
v20.6
-3
View File
@@ -8,6 +8,3 @@ packages/icons/src/data/*.json
# Build files
dist/
README.md
CHANGELOG.md
+2 -24
View File
@@ -35,10 +35,8 @@ To run a local version of this project, please follow these simple steps.
### Prerequisites
- Node.js (Version: >=20.8)
- Use nvm for easy Node management
- Bun (Version: >=1.2.1)
- We use a text-based lockfile which isn't supported below 1.2.1
- Node.js (Version: >=18.x)
- Bun
### Set up
@@ -80,26 +78,6 @@ Any published GitBook site can be accessed through your local development instan
All pull-requests will be tested against both visual and performances testing to prevent regressions.
## Fonts and Icons
GitBook Open uses fontawesome. During development, your local environment will use the free version. However, only the pro version will be accepted by CI. If you see the following error:
```
The GitBook icon is missing. It indicates that the dependencies were installed without the correct font-awesome package. These changes have probably been persisted in the Bun lockfile. Read the README for more information.
```
It means that you've changed the GBO dependencies and bundled in the free version. Only GitBook staff can help with this - if you're not on the GitBook team, please ping us in the PR and we'll help get things moving.
If you are GitBook staff, you'll need our NPM token in your local environment.
```
.env.local
NPM_TOKEN_READONLY=xxx
```
and then reinstall dependencies.
## Contributing
GitBook's rendering engine is fully open source and built on top of [Next.js](https://nextjs.org/). Head to our [contributing guide](https://github.com/GitbookIO/gitbook/blob/main/.github/CONTRIBUTING.md) to learn more about the workflow on adding your first Pull Request.

Some files were not shown because too many files have changed in this diff Show More