diff --git a/.changeset/moody-hairs-call.md b/.changeset/moody-hairs-call.md new file mode 100644 index 000000000..fce9b337f --- /dev/null +++ b/.changeset/moody-hairs-call.md @@ -0,0 +1,6 @@ +--- +'@gitbook/react-openapi': minor +'gitbook': minor +--- + +Revert scalar to 1.0.87 to mitigate an issue with ApiClientModalProvider diff --git a/README.md b/README.md index 0580fc083..16ff493f5 100644 --- a/README.md +++ b/README.md @@ -78,6 +78,26 @@ 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. diff --git a/bun.lockb b/bun.lockb index 678ca9149..70ae2be15 100755 Binary files a/bun.lockb and b/bun.lockb differ diff --git a/package.json b/package.json index 0b4fd4834..63e10374e 100644 --- a/package.json +++ b/package.json @@ -16,7 +16,7 @@ }, "private": true, "scripts": { - "dev": "turbo run dev", + "dev": "turbo run dev --ui=stream", "build": "turbo run build", "build:cloudflare": "turbo run build:cloudflare", "lint": "turbo run lint", diff --git a/packages/icons/src/pro.test.ts b/packages/icons/src/pro.test.ts index a9df513c5..bc1959111 100644 --- a/packages/icons/src/pro.test.ts +++ b/packages/icons/src/pro.test.ts @@ -4,7 +4,8 @@ import { validateIconName } from './icons'; it('should have the GitBook custom icon', () => { if (!validateIconName('gitbook')) { const message = - 'The GitBook icon is missing. It indicates that the dependencies were installed without the font-awesome custom package.'; + '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.'; + if (process.env.CI) { throw new Error(message); } else { diff --git a/packages/react-openapi/package.json b/packages/react-openapi/package.json index b05bda997..12dd99166 100644 --- a/packages/react-openapi/package.json +++ b/packages/react-openapi/package.json @@ -10,7 +10,7 @@ }, "version": "0.7.1", "dependencies": { - "@scalar/api-client-react": "1.1.2", + "@scalar/api-client-react": "1.0.87", "classnames": "^2.5.1", "flatted": "^3.2.9", "openapi-types": "^12.1.3", diff --git a/packages/react-openapi/src/OpenAPIOperation.tsx b/packages/react-openapi/src/OpenAPIOperation.tsx index 3159b88ff..031aec24c 100644 --- a/packages/react-openapi/src/OpenAPIOperation.tsx +++ b/packages/react-openapi/src/OpenAPIOperation.tsx @@ -29,7 +29,7 @@ export function OpenAPIOperation(props: { return (
diff --git a/packages/react-openapi/src/ScalarApiButton.tsx b/packages/react-openapi/src/ScalarApiButton.tsx index a3ee96a7f..074fc32fe 100644 --- a/packages/react-openapi/src/ScalarApiButton.tsx +++ b/packages/react-openapi/src/ScalarApiButton.tsx @@ -16,7 +16,7 @@ export function ScalarApiButton({ method, path }: { method: string; path: string