From f8af7f5c32eb548106c4263e7faca1cf15aff09c Mon Sep 17 00:00:00 2001 From: victoria Date: Tue, 12 Nov 2024 21:53:15 +0100 Subject: [PATCH] chore: remove type="installer" (#1689) --- docs/customization/elements/overview.mdx | 2 +- docs/customization/localization.mdx | 2 +- docs/customization/themes.mdx | 2 +- docs/guides/authjs-migration.mdx | 6 +++--- docs/integrations/databases/convex.mdx | 2 +- docs/integrations/webhooks/sync-data.mdx | 2 +- .../references/astro/migrating-from-astro-community-sdk.mdx | 2 +- docs/references/astro/react.mdx | 2 +- docs/references/expo/local-credentials.mdx | 2 +- .../expo/web-support/custom-signup-signin-pages.mdx | 2 +- docs/references/javascript/types/overview.mdx | 2 +- docs/references/nextjs/custom-signup-signin-pages.mdx | 2 +- docs/references/nextjs/usage-with-older-versions.mdx | 2 +- docs/references/nodejs/overview.mdx | 2 +- docs/references/react/add-react-router.mdx | 2 +- docs/references/redwood/overview.mdx | 2 +- docs/references/remix/custom-signup-signin-pages.mdx | 2 +- docs/references/remix/spa-mode.mdx | 2 +- .../tanstack-start/custom-signup-signin-pages.mdx | 2 +- docs/upgrade-guides/core-2/backend.mdx | 4 ++-- docs/upgrade-guides/core-2/chrome-extension.mdx | 6 +++--- docs/upgrade-guides/core-2/expo.mdx | 6 +++--- docs/upgrade-guides/core-2/fastify.mdx | 4 ++-- docs/upgrade-guides/core-2/javascript.mdx | 4 ++-- docs/upgrade-guides/core-2/nextjs.mdx | 6 +++--- docs/upgrade-guides/core-2/node.mdx | 4 ++-- docs/upgrade-guides/core-2/react.mdx | 6 +++--- docs/upgrade-guides/core-2/remix.mdx | 6 +++--- 28 files changed, 44 insertions(+), 44 deletions(-) diff --git a/docs/customization/elements/overview.mdx b/docs/customization/elements/overview.mdx index 95e17a0c9f..8c44327412 100644 --- a/docs/customization/elements/overview.mdx +++ b/docs/customization/elements/overview.mdx @@ -33,7 +33,7 @@ Clerk Elements currently only works with Next.js App Router and [Clerk Core 2](/ To get started, install the Clerk Elements package: - + ```sh {{ filename: 'terminal' }} npm install @clerk/elements ``` diff --git a/docs/customization/localization.mdx b/docs/customization/localization.mdx index 690a6e85a2..261c04b9bb 100644 --- a/docs/customization/localization.mdx +++ b/docs/customization/localization.mdx @@ -63,7 +63,7 @@ Clerk currently supports the following languages with English as the default: To get started, install the `@clerk/localizations` package. - + ```bash {{ filename: 'terminal' }} npm install @clerk/localizations ``` diff --git a/docs/customization/themes.mdx b/docs/customization/themes.mdx index c3f349be29..c9a3b5bf6f 100644 --- a/docs/customization/themes.mdx +++ b/docs/customization/themes.mdx @@ -40,7 +40,7 @@ Applied by default when no other theme is provided. 1. To get started, install the `@clerk/themes` package. - + ```bash {{ filename: 'terminal' }} npm install @clerk/themes ``` diff --git a/docs/guides/authjs-migration.mdx b/docs/guides/authjs-migration.mdx index 8663c4eb9d..2d57c67ba5 100644 --- a/docs/guides/authjs-migration.mdx +++ b/docs/guides/authjs-migration.mdx @@ -42,7 +42,7 @@ This guide shows how to migrate an application using Auth.js (formerly NextAuth. Clerk's Next.js SDK gives you access to prebuilt [components](/docs/components/overview), [hooks](/docs/references/nextjs/overview#client-side-helpers), and [helpers](/docs/references/nextjs/overview) for Next.js Server Components, Route Handlers and Middleware. Run the following command to install it: - + ```bash {{ filename: 'terminal' }} npm install @clerk/nextjs ``` @@ -71,7 +71,7 @@ This guide shows how to migrate an application using Auth.js (formerly NextAuth. You will need to remove the `` provider from Auth.js and replace it with the `` provider from Clerk. `` will need to wrap your application, or wrap the portion of your app where you want to handle authentication. - + ```tsx {{ filename: 'app/layout.tsx', mark: [1, 6, 10] }} import { ClerkProvider } from '@clerk/nextjs' import './globals.css' @@ -174,7 +174,7 @@ This guide shows how to migrate an application using Auth.js (formerly NextAuth. Replace any Auth.js `getServerSession(req, res, authOptions)` with Clerk's helpers. - + You can replace Auth.js's `setServerSession()` with Clerk's [`auth()`](/docs/references/nextjs/auth#auth) helper in order to read your user data. diff --git a/docs/integrations/databases/convex.mdx b/docs/integrations/databases/convex.mdx index 59667528c8..9cc1199c12 100644 --- a/docs/integrations/databases/convex.mdx +++ b/docs/integrations/databases/convex.mdx @@ -76,7 +76,7 @@ This tutorial assumes that you have already [set up a Clerk application](/docs/q Run the following command to install Clerk's React SDK: - + ```bash {{ filename: 'terminal' }} npm install @clerk/clerk-react ``` diff --git a/docs/integrations/webhooks/sync-data.mdx b/docs/integrations/webhooks/sync-data.mdx index 3795b32540..50047fe5e7 100644 --- a/docs/integrations/webhooks/sync-data.mdx +++ b/docs/integrations/webhooks/sync-data.mdx @@ -91,7 +91,7 @@ This guide can be adapted to listen for any Clerk event. You will use [`svix`](https://www.npmjs.com/package/svix) to verify the webhook signature. Run the following command to install it: - + ```bash {{ filename: 'terminal' }} npm install svix ``` diff --git a/docs/references/astro/migrating-from-astro-community-sdk.mdx b/docs/references/astro/migrating-from-astro-community-sdk.mdx index 6572677cd3..b7c022e476 100644 --- a/docs/references/astro/migrating-from-astro-community-sdk.mdx +++ b/docs/references/astro/migrating-from-astro-community-sdk.mdx @@ -9,7 +9,7 @@ In July 2024, we introduced official support for Astro. This migration guide cov Uninstall the community SDK and install Clerk's new official SDK for Astro. - + ```bash {{ filename: 'terminal' }} npm uninstall astro-clerk-auth npm install @clerk/astro diff --git a/docs/references/astro/react.mdx b/docs/references/astro/react.mdx index d39e4050fe..4fe35104d9 100644 --- a/docs/references/astro/react.mdx +++ b/docs/references/astro/react.mdx @@ -12,7 +12,7 @@ If you have not set up your Astro application to work with Clerk, visit the [Ast Add the [Astro React integration](https://docs.astro.build/en/guides/integrations-guide/react/) to your project: - + ```bash {{ filename: 'terminal' }} npx astro add react ``` diff --git a/docs/references/expo/local-credentials.mdx b/docs/references/expo/local-credentials.mdx index c5859c8c99..75ff945425 100644 --- a/docs/references/expo/local-credentials.mdx +++ b/docs/references/expo/local-credentials.mdx @@ -16,7 +16,7 @@ This guide shows you how to use the `useLocalCredentials()` hook to enhance your These packages are required to be installed in order to use the `useLocalCredentials()` hook. - + ```bash {{ filename: 'terminal' }} npm install expo-local-authentication expo-secure-store ``` diff --git a/docs/references/expo/web-support/custom-signup-signin-pages.mdx b/docs/references/expo/web-support/custom-signup-signin-pages.mdx index 9f7e871281..5890a38cdf 100644 --- a/docs/references/expo/web-support/custom-signup-signin-pages.mdx +++ b/docs/references/expo/web-support/custom-signup-signin-pages.mdx @@ -36,7 +36,7 @@ This guide uses [Expo Router](https://docs.expo.dev/router/introduction/) and th To run your project, use the following command: - + ```bash filename="terminal" npm run web ``` diff --git a/docs/references/javascript/types/overview.mdx b/docs/references/javascript/types/overview.mdx index 6bb3ae5b89..0772177c64 100644 --- a/docs/references/javascript/types/overview.mdx +++ b/docs/references/javascript/types/overview.mdx @@ -7,7 +7,7 @@ Types are a powerful tool for adding type-safety to your application. They can h To get access to Clerk types, you need to add the `@clerk/types` package to your project. Run the following command to install it: - + ```bash {{ filename: 'terminal' }} npm install @clerk/types ``` diff --git a/docs/references/nextjs/custom-signup-signin-pages.mdx b/docs/references/nextjs/custom-signup-signin-pages.mdx index 20594ac785..edf6b342d0 100644 --- a/docs/references/nextjs/custom-signup-signin-pages.mdx +++ b/docs/references/nextjs/custom-signup-signin-pages.mdx @@ -106,7 +106,7 @@ If Clerk's prebuilt components don't meet your specific needs or if you require Run your project with the following terminal command from the root directory of your project: - + ```bash {{ filename: 'terminal' }} npm run dev ``` diff --git a/docs/references/nextjs/usage-with-older-versions.mdx b/docs/references/nextjs/usage-with-older-versions.mdx index 1e1c50a3d5..d5235b44c8 100644 --- a/docs/references/nextjs/usage-with-older-versions.mdx +++ b/docs/references/nextjs/usage-with-older-versions.mdx @@ -13,7 +13,7 @@ Clerk's [prebuilt components](/docs/components/overview) are exported from the ` Install `^4.0.0` of `@clerk/nextjs`. Newer major versions of `@clerk/nextjs` only support Next.js 13+. - + ```bash {{ filename: 'terminal' }} npm install @clerk/nextjs@^4.0.0 ``` diff --git a/docs/references/nodejs/overview.mdx b/docs/references/nodejs/overview.mdx index 897130a073..9642e5de41 100644 --- a/docs/references/nodejs/overview.mdx +++ b/docs/references/nodejs/overview.mdx @@ -17,7 +17,7 @@ description: Learn how to integrate Node.js into your Clerk application. Once a Clerk application has been created, you can install and then start using Clerk Node.js in your application. An ESM module for the Clerk Node SDK is available under the [`@clerk/clerk-sdk-node`](https://www.npmjs.com/package/@clerk/clerk-sdk-node) npm package. - + ```sh {{ filename: 'terminal' }} npm install @clerk/clerk-sdk-node ``` diff --git a/docs/references/react/add-react-router.mdx b/docs/references/react/add-react-router.mdx index 4d9db9b8a4..9af1ce6d8f 100644 --- a/docs/references/react/add-react-router.mdx +++ b/docs/references/react/add-react-router.mdx @@ -41,7 +41,7 @@ Learn how to add React Router to your application using React Router's new Data React Router's `react-router-dom` is a mature, battle tested routing package for React that gives you many options. As it is the most popular routing option, it will be used for this guide. - + ```bash {{ filename: 'terminal' }} npm install react-router-dom ``` diff --git a/docs/references/redwood/overview.mdx b/docs/references/redwood/overview.mdx index d372a49d85..3b0c01d3fb 100644 --- a/docs/references/redwood/overview.mdx +++ b/docs/references/redwood/overview.mdx @@ -8,7 +8,7 @@ Learn how to use Clerk to quickly and easily add secure authentication and user ### Create a RedwoodJS application - + ```bash {{ filename: 'terminal' }} npm create redwood-app my-redwood-project --typescript ``` diff --git a/docs/references/remix/custom-signup-signin-pages.mdx b/docs/references/remix/custom-signup-signin-pages.mdx index 0c212ad8b3..3943858c38 100644 --- a/docs/references/remix/custom-signup-signin-pages.mdx +++ b/docs/references/remix/custom-signup-signin-pages.mdx @@ -82,7 +82,7 @@ The functionality of the components are controlled by the instance settings you Run your project with the following terminal command from the root directory of your project: - + ```bash {{ filename: 'terminal' }} npm run dev ``` diff --git a/docs/references/remix/spa-mode.mdx b/docs/references/remix/spa-mode.mdx index 3b7c7979bd..b6c68cd7c5 100644 --- a/docs/references/remix/spa-mode.mdx +++ b/docs/references/remix/spa-mode.mdx @@ -29,7 +29,7 @@ description: Clerk supports Remix SPA mode out-of-the-box. Once you have a Remix application ready, you need to install Clerk's Remix SDK. This gives you access to our prebuilt components and hooks for Remix applications. - + ```bash {{ filename: 'terminal' }} npm install @clerk/remix ``` diff --git a/docs/references/tanstack-start/custom-signup-signin-pages.mdx b/docs/references/tanstack-start/custom-signup-signin-pages.mdx index 08474a3cb2..80234e0594 100644 --- a/docs/references/tanstack-start/custom-signup-signin-pages.mdx +++ b/docs/references/tanstack-start/custom-signup-signin-pages.mdx @@ -60,7 +60,7 @@ If Clerk's prebuilt components don't meet your specific needs or if you require Run your project with the following command: - + ```bash {{ filename: 'terminal' }} npm run dev ``` diff --git a/docs/upgrade-guides/core-2/backend.mdx b/docs/upgrade-guides/core-2/backend.mdx index eb0041cef5..a1e181d5a0 100644 --- a/docs/upgrade-guides/core-2/backend.mdx +++ b/docs/upgrade-guides/core-2/backend.mdx @@ -23,7 +23,7 @@ You need to have Node.js `18.17.0` or later installed. Last year, Node.js 16 ent Whenever you feel ready, go ahead and install the latest version of any Clerk SDKs you are using. Make sure that you are prepared to patch some breaking changes before your app will work properly, however. The commands below demonstrate how to install the latest version. - + ```bash {{ filename: 'terminal' }} npm install @clerk/backend ``` @@ -43,7 +43,7 @@ Clerk now provides a `@clerk/upgrade` CLI tool that you can use to ease the upgr To run the CLI tool, navigate to your project and run it in the terminal: - + ```bash {{ filename: 'terminal' }} npx @clerk/upgrade ``` diff --git a/docs/upgrade-guides/core-2/chrome-extension.mdx b/docs/upgrade-guides/core-2/chrome-extension.mdx index 8f872bb849..db6b73ab86 100644 --- a/docs/upgrade-guides/core-2/chrome-extension.mdx +++ b/docs/upgrade-guides/core-2/chrome-extension.mdx @@ -23,7 +23,7 @@ You need to have Node.js `18.17.0` or later installed. Last year, Node.js 16 ent All react-dependent Clerk SDKs now require you to use React 18 or higher. You can update your project by installing the latest version of `react` and `react-dom`. - + ```bash {{ filename: 'terminal' }} npm install react@latest react-dom@latest ``` @@ -43,7 +43,7 @@ If you are upgrading from React 17 or lower, make sure to [learn about how to up Whenever you feel ready, go ahead and install the latest version of any Clerk SDKs you are using. Make sure that you are prepared to patch some breaking changes before your app will work properly, however. The commands below demonstrate how to install the latest version. - + ```bash {{ filename: 'terminal' }} npm install @clerk/chrome-extension ``` @@ -63,7 +63,7 @@ Clerk now provides a `@clerk/upgrade` CLI tool that you can use to ease the upgr To run the CLI tool, navigate to your project and run it in the terminal: - + ```bash {{ filename: 'terminal' }} npx @clerk/upgrade ``` diff --git a/docs/upgrade-guides/core-2/expo.mdx b/docs/upgrade-guides/core-2/expo.mdx index 714323a7d0..661f112d00 100644 --- a/docs/upgrade-guides/core-2/expo.mdx +++ b/docs/upgrade-guides/core-2/expo.mdx @@ -23,7 +23,7 @@ You need to have Node.js `18.17.0` or later installed. Last year, Node.js 16 ent All react-dependent Clerk SDKs now require you to use React 18 or higher. You can update your project by installing the latest version of `react` and `react-dom`. - + ```bash {{ filename: 'terminal' }} npm install react@latest react-dom@latest ``` @@ -43,7 +43,7 @@ If you are upgrading from React 17 or lower, make sure to [learn about how to up Whenever you feel ready, go ahead and install the latest version of any Clerk SDKs you are using. Make sure that you are prepared to patch some breaking changes before your app will work properly, however. The commands below demonstrate how to install the latest version. - + ```bash {{ filename: 'terminal' }} npm install @clerk/clerk-expo ``` @@ -63,7 +63,7 @@ Clerk now provides a `@clerk/upgrade` CLI tool that you can use to ease the upgr To run the CLI tool, navigate to your project and run it in the terminal: - + ```bash {{ filename: 'terminal' }} npx @clerk/upgrade ``` diff --git a/docs/upgrade-guides/core-2/fastify.mdx b/docs/upgrade-guides/core-2/fastify.mdx index b38512e70c..2520abe2cf 100644 --- a/docs/upgrade-guides/core-2/fastify.mdx +++ b/docs/upgrade-guides/core-2/fastify.mdx @@ -23,7 +23,7 @@ You need to have Node.js `18.17.0` or later installed. Last year, Node.js 16 ent Whenever you feel ready, go ahead and install the latest version of any Clerk SDKs you are using. Make sure that you are prepared to patch some breaking changes before your app will work properly, however. The commands below demonstrate how to install the latest version. - + ```bash {{ filename: 'terminal' }} npm install @clerk/fastify ``` @@ -43,7 +43,7 @@ Clerk now provides a `@clerk/upgrade` CLI tool that you can use to ease the upgr To run the CLI tool, navigate to your project and run it in the terminal: - + ```bash {{ filename: 'terminal' }} npx @clerk/upgrade ``` diff --git a/docs/upgrade-guides/core-2/javascript.mdx b/docs/upgrade-guides/core-2/javascript.mdx index 3f3007d448..6f554ffa33 100644 --- a/docs/upgrade-guides/core-2/javascript.mdx +++ b/docs/upgrade-guides/core-2/javascript.mdx @@ -19,7 +19,7 @@ Additionally, some of the minimum version requirements for some base dependencie Whenever you feel ready, go ahead and install the latest version of any Clerk SDKs you are using. Make sure that you are prepared to patch some breaking changes before your app will work properly, however. The commands below demonstrate how to install the latest version. - + ```bash {{ filename: 'terminal' }} npm install @clerk/clerk-js ``` @@ -39,7 +39,7 @@ Clerk now provides a `@clerk/upgrade` CLI tool that you can use to ease the upgr To run the CLI tool, navigate to your project and run it in the terminal: - + ```bash {{ filename: 'terminal' }} npx @clerk/upgrade ``` diff --git a/docs/upgrade-guides/core-2/nextjs.mdx b/docs/upgrade-guides/core-2/nextjs.mdx index dd6d57c537..0eaa28ac96 100644 --- a/docs/upgrade-guides/core-2/nextjs.mdx +++ b/docs/upgrade-guides/core-2/nextjs.mdx @@ -23,7 +23,7 @@ You need to have Node.js `18.17.0` or later installed. Last year, Node.js 16 ent All react-dependent Clerk SDKs now require you to use React 18 or higher. You can update your project by installing the latest version of `react` and `react-dom`. - + ```bash {{ filename: 'terminal' }} npm install react@latest react-dom@latest ``` @@ -50,7 +50,7 @@ If you are upgrading from React 17 or lower, make sure to [learn about how to up Whenever you feel ready, go ahead and install the latest version of any Clerk SDKs you are using. Make sure that you are prepared to patch some breaking changes before your app will work properly, however. The commands below demonstrate how to install the latest version. - + ```bash {{ filename: 'terminal' }} npm install @clerk/nextjs ``` @@ -70,7 +70,7 @@ Clerk now provides a `@clerk/upgrade` CLI tool that you can use to ease the upgr To run the CLI tool, navigate to your project and run it in the terminal: - + ```bash {{ filename: 'terminal' }} npx @clerk/upgrade ``` diff --git a/docs/upgrade-guides/core-2/node.mdx b/docs/upgrade-guides/core-2/node.mdx index 9fe7f9d44c..21443f82b5 100644 --- a/docs/upgrade-guides/core-2/node.mdx +++ b/docs/upgrade-guides/core-2/node.mdx @@ -26,7 +26,7 @@ You need to have Node.js `18.17.0` or later installed. Last year, Node.js 16 ent Whenever you feel ready, go ahead and install the latest version of any Clerk SDKs you are using. Make sure that you are prepared to patch some breaking changes before your app will work properly, however. The commands below demonstrate how to install the latest version. - + ```bash {{ filename: 'terminal' }} npm install @clerk/clerk-sdk-node ``` @@ -46,7 +46,7 @@ Clerk now provides a `@clerk/upgrade` CLI tool that you can use to ease the upgr To run the CLI tool, navigate to your project and run it in the terminal: - + ```bash {{ filename: 'terminal' }} npx @clerk/upgrade ``` diff --git a/docs/upgrade-guides/core-2/react.mdx b/docs/upgrade-guides/core-2/react.mdx index a43f719021..cce2066b3f 100644 --- a/docs/upgrade-guides/core-2/react.mdx +++ b/docs/upgrade-guides/core-2/react.mdx @@ -23,7 +23,7 @@ You need to have Node.js `18.17.0` or later installed. Last year, Node.js 16 ent All react-dependent Clerk SDKs now require you to use React 18 or higher. You can update your project by installing the latest version of `react` and `react-dom`. - + ```bash {{ filename: 'terminal' }} npm install react@latest react-dom@latest ``` @@ -43,7 +43,7 @@ If you are upgrading from React 17 or lower, make sure to [learn about how to up Whenever you feel ready, go ahead and install the latest version of any Clerk SDKs you are using. Make sure that you are prepared to patch some breaking changes before your app will work properly, however. The commands below demonstrate how to install the latest version. - + ```bash {{ filename: 'terminal' }} npm install @clerk/clerk-react ``` @@ -63,7 +63,7 @@ Clerk now provides a `@clerk/upgrade` CLI tool that you can use to ease the upgr To run the CLI tool, navigate to your project and run it in the terminal: - + ```bash {{ filename: 'terminal' }} npx @clerk/upgrade ``` diff --git a/docs/upgrade-guides/core-2/remix.mdx b/docs/upgrade-guides/core-2/remix.mdx index 4af8976f93..266be97e02 100644 --- a/docs/upgrade-guides/core-2/remix.mdx +++ b/docs/upgrade-guides/core-2/remix.mdx @@ -23,7 +23,7 @@ You need to have Node.js `18.17.0` or later installed. Last year, Node.js 16 ent All react-dependent Clerk SDKs now require you to use React 18 or higher. You can update your project by installing the latest version of `react` and `react-dom`. - + ```bash {{ filename: 'terminal' }} npm install react@latest react-dom@latest ``` @@ -43,7 +43,7 @@ If you are upgrading from React 17 or lower, make sure to [learn about how to up Whenever you feel ready, go ahead and install the latest version of any Clerk SDKs you are using. Make sure that you are prepared to patch some breaking changes before your app will work properly, however. The commands below demonstrate how to install the latest version. - + ```bash {{ filename: 'terminal' }} npm install @clerk/remix ``` @@ -63,7 +63,7 @@ Clerk now provides a `@clerk/upgrade` CLI tool that you can use to ease the upgr To run the CLI tool, navigate to your project and run it in the terminal: - + ```bash {{ filename: 'terminal' }} npx @clerk/upgrade ```