Skip to content
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
c70031e
Adjust customization docs, clarify options and move account portal ou…
brkalow Nov 22, 2025
39c5065
update AP links
brkalow Nov 22, 2025
c418514
more links
brkalow Nov 22, 2025
f1d1a62
tweak themes section
brkalow Nov 22, 2025
89b898d
remove WIP artifacts
brkalow Nov 22, 2025
90a4b6e
adjust heading hierarchy
brkalow Nov 22, 2025
d7a2441
Merge branch 'main' into brk.feat/customization-docs-tweaks
brkalow Dec 2, 2025
9d06e1e
Merge branch 'main' into brk.feat/customization-docs-tweaks
brkalow Dec 3, 2025
36ba7f1
update old ap route references
brkalow Dec 2, 2025
3be0c95
Tweak manifest
brkalow Dec 3, 2025
0722730
Merge branch 'main' into brk.feat/customization-docs-tweaks
SarahSoutoul Dec 3, 2025
8b85e1e
linting
SarahSoutoul Dec 3, 2025
9270228
docs review
SarahSoutoul Dec 3, 2025
ba6c706
Merge branch 'main' into brk.feat/customization-docs-tweaks
SarahSoutoul Dec 4, 2025
7439aec
docs review
alexisintech Dec 5, 2025
b82b48e
Merge branch 'main' into brk.feat/customization-docs-tweaks
SarahSoutoul Dec 5, 2025
3759307
Address discussion pts
SarahSoutoul Dec 5, 2025
a27e909
linting
SarahSoutoul Dec 5, 2025
9f540df
Remove clerk typedoc
SarahSoutoul Dec 5, 2025
c911d7a
Remove clerk typedoc
SarahSoutoul Dec 5, 2025
c1782ef
Revamp of overview
SarahSoutoul Dec 8, 2025
da141d5
Fix lintign
SarahSoutoul Dec 8, 2025
5ac8e12
Update docs/guides/account-portal/disable-account-portal.mdx
SarahSoutoul Dec 8, 2025
f07675b
Update docs/guides/account-portal/getting-started.mdx
SarahSoutoul Dec 8, 2025
2b3bb43
Update docs/guides/account-portal/disable-account-portal.mdx
SarahSoutoul Dec 8, 2025
328af22
Update docs/guides/account-portal/overview.mdx
SarahSoutoul Dec 8, 2025
f065f22
Remove unnecessary redirect
SarahSoutoul Dec 8, 2025
81a30ca
Change order
SarahSoutoul Dec 8, 2025
45f5f43
Linting
SarahSoutoul Dec 8, 2025
bb85a85
Merge branch 'main' into brk.feat/customization-docs-tweaks
SarahSoutoul Dec 8, 2025
4886f9d
Merge branch 'main' into brk.feat/customization-docs-tweaks
SarahSoutoul Dec 10, 2025
7711d0e
Merge branch 'main' into brk.feat/customization-docs-tweaks
SarahSoutoul Dec 10, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions clerk-typedoc/clerk-react/clerk-provider-props.mdx

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/_partials/authentication/passkeys-restriction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Passkeys are tied to the domain they are created on and **cannot be used across
If you're **not** using satellite domains:

- **In development**, you can either:
- **The recommended approach**. Use Clerk's [components](/docs/reference/components/overview), [Elements](/docs/guides/customizing-clerk/elements/overview), or [custom flows](!custom-flow), instead of the [Account Portal](/docs/guides/customizing-clerk/account-portal). This ensures the passkey is created and used entirely on your development domain, so passkeys created on `localhost` will only work on `localhost`.
- **The recommended approach**. Use Clerk's [components](/docs/reference/components/overview), [Elements](/docs/guides/customizing-clerk/elements/overview), or [custom flows](!custom-flow), instead of the [Account Portal](/docs/guides/account-portal/overview). This ensures the passkey is created and used entirely on your development domain, so passkeys created on `localhost` will only work on `localhost`.
- Create a passkey directly through the Account Portal instead of your local application to keep it tied to the Account Portal's domain. Passkeys created on your Account Portal (e.g., `your-app.accounts.dev`) will only work on that domain, which can cause issues if you switch between `localhost` and the Account Portal during development. If you choose this approach, ensure all testing happens on the same domain where the passkey was created.

- **In production,** your Account Portal is usually hosted on a subdomain of your main domain (e.g. `accounts.your-domain.com`), enabling passkeys to work seamlessly across your app. However, as stated above, if you use **satellite domains**, passkeys will not work as intended.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
The simplest way to test your connection is to visit your Clerk app's [Account Portal](/docs/guides/customizing-clerk/account-portal), which is available for all Clerk apps out-of-the-box.
The simplest way to test your connection is to visit your Clerk app's [Account Portal](/docs/guides/account-portal/overview), which is available for all Clerk apps out-of-the-box.

1. In the Clerk Dashboard, navigate to the [**Account Portal**](https://dashboard.clerk.com/~/account-portal) page.
1. Next to **Sign-in**, select the button to visit the sign-in page. The URL should resemble:
Expand Down
4 changes: 2 additions & 2 deletions docs/_partials/clerk-provider/properties.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -228,9 +228,9 @@
- `waitlistUrl`
- `string`

The full URL or path to the waitlist page. If `undefined`, will redirect to the [Account Portal waitlist page](/docs/guides/customizing-clerk/account-portal#waitlist).
The full URL or path to the waitlist page. If `undefined`, will redirect to the [Account Portal waitlist page](/docs/guides/account-portal/overview#waitlist).
</Properties>

[components-ref]: /docs/reference/components/overview

[ap-ref]: /docs/guides/customizing-clerk/account-portal
[ap-ref]: /docs/guides/account-portal/overview
2 changes: 1 addition & 1 deletion docs/_partials/custom-flows-callout.mdx
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
> [!WARNING]
> This guide is for users who want to build a [custom flow](!custom-flow). To use a _prebuilt_ UI, use the [Account Portal pages](/docs/guides/customizing-clerk/account-portal) or [prebuilt components](/docs/reference/components/overview).
> This guide is for users who want to build a [custom flow](!custom-flow). To use a _prebuilt_ UI, use the [Account Portal pages](/docs/guides/account-portal/overview) or [prebuilt components](/docs/reference/components/overview).
2 changes: 1 addition & 1 deletion docs/_partials/update-clerk-options-properties.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@

[components-ref]: /docs/reference/components/overview

[ap-ref]: /docs/guides/customizing-clerk/account-portal
[ap-ref]: /docs/guides/account-portal/overview
2 changes: 1 addition & 1 deletion docs/getting-started/core-concepts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Before building your application, it's important to understand the core concepts

Clerk provides three ways to integrate authentication into your application, depending on the level of control and customization you need:

1. **[Account Portal](/docs/guides/customizing-clerk/account-portal) (default)**: Uses Clerk's prebuilt components on dedicated pages that are hosted on Clerk servers. Every Clerk application has this enabled by default, providing a complete user management interface out of the box.
1. **[Account Portal](/docs/guides/account-portal/overview) (default)**: Uses Clerk's prebuilt components on dedicated pages that are hosted on Clerk servers. Every Clerk application has this enabled by default, providing a complete user management interface out of the box.
1. **[Prebuilt components](/docs/reference/components/overview)**: All-in-one UI components that can be integrated into your application. They are fully customizable to match your application's branding and design. This is the recommended approach for most use cases.
1. **[Custom flows](!custom-flow) using the Clerk API**: Build your own UI using the Clerk API. This option provides maximum flexibility and control over the user experience but requires more development effort.

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/quickstart.astro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ sdk: astro
- [`<SignedIn>`](/docs/reference/components/control/signed-in): Children of this component can only be seen while **signed in**.
- [`<SignedOut>`](/docs/reference/components/control/signed-out): Children of this component can only be seen while **signed out**.
- [`<UserButton />`](/docs/reference/components/user/user-button): Shows the signed-in user's avatar. Selecting it opens a dropdown menu with account management options.
- [`<SignInButton />`](/docs/reference/components/unstyled/sign-in-button): An unstyled component that links to the sign-in page. In this example, since no props or [environment variables](/docs/guides/development/clerk-environment-variables) are set for the sign-in URL, this component links to the [Account Portal sign-in page](/docs/guides/customizing-clerk/account-portal#sign-in).
- [`<SignInButton />`](/docs/reference/components/unstyled/sign-in-button): An unstyled component that links to the sign-in page. In this example, since no props or [environment variables](/docs/guides/development/clerk-environment-variables) are set for the sign-in URL, this component links to the [Account Portal sign-in page](/docs/guides/account-portal/overview#sign-in).

```astro {{ filename: 'src/layouts/Layout.astro', mark: [[1, 3], [15, 22]], fold: [[27, 34]] }}
---
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/quickstart.chrome-extension.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ sdk: chrome-extension
- [`<SignedIn>`](/docs/reference/components/control/signed-in): Children of this component can only be seen while **signed in**.
- [`<SignedOut>`](/docs/reference/components/control/signed-out): Children of this component can only be seen while **signed out**.
- [`<UserButton />`](/docs/reference/components/user/user-button): A prebuilt component that comes styled out-of-the-box to show the avatar from the account the user is signed in with.
- [`<SignInButton />`](/docs/reference/components/unstyled/sign-in-button): An unstyled component that links to the sign-in page. For this example, because you have not specified any props or [environment variables](/docs/guides/development/clerk-environment-variables) for the sign-in URL, the component will link to the [Account Portal sign-in page](/docs/guides/customizing-clerk/account-portal#sign-in).
- [`<SignInButton />`](/docs/reference/components/unstyled/sign-in-button): An unstyled component that links to the sign-in page. For this example, because you have not specified any props or [environment variables](/docs/guides/development/clerk-environment-variables) for the sign-in URL, the component will link to the [Account Portal sign-in page](/docs/guides/account-portal/overview#sign-in).

```tsx {{ filename: 'src/popup.tsx', mark: [[1, 7], [22, 29]] }}
import {
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/quickstart.nuxt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ sdk: nuxt
- [`<SignedIn>`](/docs/reference/components/control/signed-in): Children of this component can only be seen while **signed in**.
- [`<SignedOut>`](/docs/reference/components/control/signed-out): Children of this component can only be seen while **signed out**.
- [`<UserButton />`](/docs/reference/components/user/user-button): Shows the signed-in user's avatar. Selecting it opens a dropdown menu with account management options.
- [`<SignInButton />`](/docs/reference/components/unstyled/sign-in-button): An unstyled component that links to the sign-in page or displays the sign-in modal. In this example, since no props or [environment variables](/docs/guides/development/clerk-environment-variables) are set for the sign-in URL, this component links to the [Account Portal sign-in page](/docs/guides/customizing-clerk/account-portal#sign-in).
- [`<SignInButton />`](/docs/reference/components/unstyled/sign-in-button): An unstyled component that links to the sign-in page or displays the sign-in modal. In this example, since no props or [environment variables](/docs/guides/development/clerk-environment-variables) are set for the sign-in URL, this component links to the [Account Portal sign-in page](/docs/guides/account-portal/overview#sign-in).

```vue {{ filename: 'app/app.vue', mark: [2, [6, 13]] }}
<script setup lang="ts">
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/quickstart.react-router.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ This tutorial assumes that you're using React Router **v7.1.2 or later** in fram
- [`<SignedIn>`](/docs/reference/components/control/signed-in): Children of this component can only be seen while **signed in**.
- [`<SignedOut>`](/docs/reference/components/control/signed-out): Children of this component can only be seen while **signed out**.
- [`<UserButton />`](/docs/reference/components/user/user-button): Shows the signed-in user's avatar. Selecting it opens a dropdown menu with account management options.
- [`<SignInButton />`](/docs/reference/components/unstyled/sign-in-button): An unstyled component that links to the sign-in page. In this example, since no props or [environment variables](/docs/guides/development/clerk-environment-variables) are set for the sign-in URL, this component links to the [Account Portal sign-in page](/docs/guides/customizing-clerk/account-portal#sign-in).
- [`<SignInButton />`](/docs/reference/components/unstyled/sign-in-button): An unstyled component that links to the sign-in page. In this example, since no props or [environment variables](/docs/guides/development/clerk-environment-variables) are set for the sign-in URL, this component links to the [Account Portal sign-in page](/docs/guides/account-portal/overview#sign-in).

```tsx {{ filename: 'app/root.tsx', mark: [44, [46, 58], 60], fold: [[2, 42], [62, 87]] }}
import { ClerkProvider, SignedIn, SignedOut, UserButton, SignInButton } from '@clerk/react-router'
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/quickstart.react.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ This tutorial will demonstrate how to create a new React app using Vite and add
- [`<SignedIn>`](/docs/reference/components/control/signed-in): Children of this component can only be seen while **signed in**.
- [`<SignedOut>`](/docs/reference/components/control/signed-out): Children of this component can only be seen while **signed out**.
- [`<UserButton />`](/docs/reference/components/user/user-button): Shows the signed-in user's avatar. Selecting it opens a dropdown menu with account management options.
- [`<SignInButton />`](/docs/reference/components/unstyled/sign-in-button): An unstyled component that links to the sign-in page. In this example, since no props or [environment variables](/docs/guides/development/clerk-environment-variables) are set for the sign-in URL, this component links to the [Account Portal sign-in page](/docs/guides/customizing-clerk/account-portal#sign-in).
- [`<SignInButton />`](/docs/reference/components/unstyled/sign-in-button): An unstyled component that links to the sign-in page. In this example, since no props or [environment variables](/docs/guides/development/clerk-environment-variables) are set for the sign-in URL, this component links to the [Account Portal sign-in page](/docs/guides/account-portal/overview#sign-in).

```tsx {{ filename: 'src/App.tsx', mark: [1, [5, 12]] }}
import { SignedIn, SignedOut, SignInButton, UserButton } from '@clerk/clerk-react'
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/quickstart.remix.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ Learn how to use Clerk to quickly and easily add secure authentication and user
- [`<SignedIn>`](/docs/reference/components/control/signed-in): Children of this component can only be seen while **signed in**.
- [`<SignedOut>`](/docs/reference/components/control/signed-out): Children of this component can only be seen while **signed out**.
- [`<UserButton />`](/docs/reference/components/user/user-button): Shows the signed-in user's avatar. Selecting it opens a dropdown menu with account management options.
- [`<SignInButton />`](/docs/reference/components/unstyled/sign-in-button): An unstyled component that links to the sign-in page. In this example, since no props or [environment variables](/docs/guides/development/clerk-environment-variables) are set for the sign-in URL, this component links to the [Account Portal sign-in page](/docs/guides/customizing-clerk/account-portal#sign-in).
- [`<SignInButton />`](/docs/reference/components/unstyled/sign-in-button): An unstyled component that links to the sign-in page. In this example, since no props or [environment variables](/docs/guides/development/clerk-environment-variables) are set for the sign-in URL, this component links to the [Account Portal sign-in page](/docs/guides/account-portal/overview#sign-in).

```tsx {{ filename: 'routes/_index.tsx' }}
import {
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/quickstart.tanstack-react-start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ sdk: tanstack-react-start
- [`<SignedIn>`](/docs/reference/components/control/signed-in): Children of this component can only be seen while **signed in**.
- [`<SignedOut>`](/docs/reference/components/control/signed-out): Children of this component can only be seen while **signed out**.
- [`<UserButton />`](/docs/reference/components/user/user-button): Shows the signed-in user's avatar. Selecting it opens a dropdown menu with account management options.
- [`<SignInButton />`](/docs/reference/components/unstyled/sign-in-button): An unstyled component that links to the sign-in page. In this example, since no props or [environment variables](/docs/guides/development/clerk-environment-variables) are set for the sign-in URL, this component links to the [Account Portal sign-in page](/docs/guides/customizing-clerk/account-portal#sign-in).
- [`<SignInButton />`](/docs/reference/components/unstyled/sign-in-button): An unstyled component that links to the sign-in page. In this example, since no props or [environment variables](/docs/guides/development/clerk-environment-variables) are set for the sign-in URL, this component links to the [Account Portal sign-in page](/docs/guides/account-portal/overview#sign-in).

```tsx {{ filename: 'src/routes/index.tsx' }}
import { SignedIn, UserButton, SignedOut, SignInButton } from '@clerk/tanstack-react-start'
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/quickstart/pages-router.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ sdk: nextjs
- [`<SignedIn>`](/docs/reference/components/control/signed-in): Children of this component can only be seen while **signed in**.
- [`<SignedOut>`](/docs/reference/components/control/signed-out): Children of this component can only be seen while **signed out**.
- [`<UserButton />`](/docs/reference/components/user/user-button): Shows the signed-in user's avatar. Selecting it opens a dropdown menu with account management options.
- [`<SignInButton />`](/docs/reference/components/unstyled/sign-in-button): An unstyled component that links to the sign-in page. In this example, since no props or [environment variables](/docs/guides/development/clerk-environment-variables) are set for the sign-in URL, this component links to the [Account Portal sign-in page](/docs/guides/customizing-clerk/account-portal#sign-in).
- [`<SignInButton />`](/docs/reference/components/unstyled/sign-in-button): An unstyled component that links to the sign-in page. In this example, since no props or [environment variables](/docs/guides/development/clerk-environment-variables) are set for the sign-in URL, this component links to the [Account Portal sign-in page](/docs/guides/account-portal/overview#sign-in).

```tsx {{ filename: 'pages/_app.tsx', mark: [2, [7, 18], 20] }}
import '@/styles/globals.css'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ To make the setup process easier, it's recommended to keep two browser tabs open

## Test your connection

The simplest way to test your enterprise connection is to visit your Clerk app's [Account Portal](/docs/guides/customizing-clerk/account-portal), which is available for all Clerk apps out-of-the-box.
The simplest way to test your enterprise connection is to visit your Clerk app's [Account Portal](/docs/guides/account-portal/overview), which is available for all Clerk apps out-of-the-box.

1. In the Clerk Dashboard, navigate to the [**Account Portal**](https://dashboard.clerk.com/~/account-portal) page.
1. Next to the **Sign-in** URL, select **Visit**. The URL should resemble:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -134,11 +134,11 @@ The following MFA strategies are currently available:
- **Authenticator application (also known as TOTP - Time-based One-time Password)**
- **Backup codes**

Enabling MFA allows users of your app to turn it on for their own accounts through their [User Profile](/docs/guides/customizing-clerk/account-portal#user-profile) page. Enabling MFA does not automatically turn on MFA for all users.
Enabling MFA allows users of your app to turn it on for their own accounts through their [User Profile](/docs/guides/account-portal/overview#user-profile) page. Enabling MFA does not automatically turn on MFA for all users.

<Include src="_partials/duo-authenticator-app-callout.mdx" />

If you're building a custom user interface instead of using the [Account Portal](/docs/guides/customizing-clerk/account-portal) or [prebuilt components](/docs/reference/components/overview), you can use [elements](/docs/guides/customizing-clerk/elements/examples/sign-in#multi-factor-authentication-mfa) or [the Clerk API](/docs/guides/development/custom-flows/authentication/email-password-mfa) to build a custom sign-in flow that allows users to sign in with MFA.
If you're building a custom user interface instead of using the [Account Portal](/docs/guides/account-portal/overview) or [prebuilt components](/docs/reference/components/overview), you can use [elements](/docs/guides/customizing-clerk/elements/examples/sign-in#multi-factor-authentication-mfa) or [the Clerk API](/docs/guides/development/custom-flows/authentication/email-password-mfa) to build a custom sign-in flow that allows users to sign in with MFA.

### Reset a user's MFA

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -421,7 +421,7 @@ To configure the option for users to sign up and sign in with a social provider:

When signed in, a user can connect to further social providers. There is no need to perform another sign-up.

When using the [Account Portal](/docs/guides/customizing-clerk/account-portal) pages, users can see which providers they have already connected to and which ones they can still connect to on their [user profile page](/docs/guides/customizing-clerk/account-portal#user-profile).
When using the [Account Portal](/docs/guides/account-portal/overview) pages, users can see which providers they have already connected to and which ones they can still connect to on their [user profile page](/docs/guides/account-portal/overview#user-profile).

When using the [prebuilt components](/docs/reference/components/overview), you can use the [`<UserProfile/>`](/docs/reference/components/user/user-profile) component to allow users to connect to further social providers.

Expand Down
Loading