Skip to content

Commit f8417ae

Browse files
committed
normalise titles
1 parent c94f5da commit f8417ae

File tree

351 files changed

+203
-896
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

351 files changed

+203
-896
lines changed

Diff for: docs/account-portal/custom-redirects.mdx

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
---
2-
title: Customizing your Account Portal redirect
2+
title: Customizing your Account Portal redirects
33
description: Customize where your users are redirected to after they sign in or sign up.
44
---
55

6-
# Customizing your Account Portal redirects
7-
86
After a user signs in or signs up, Clerk automatically redirects users back to your application by appending a `redirect_url` query param on the Account Portal page. However, Clerk provides various options for you to customize where your users are redirected to.
97

108
## Environment variables

Diff for: docs/account-portal/direct-links.mdx

-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: Direct links
33
description: Learn how to share direct links to your Account Portal pages, and how to set up fallback redirects.
44
---
55

6-
# Direct links
7-
86
## Redirect URL
97

108
If a user accesses an Account Portal page *directly*, the `redirect_url` query param will not be present, so the user cannot be redirected back to your application once they are finished with their Account Portal flow. To prevent this, it is recommend that you always specify the redirect in the link when sharing it.

Diff for: docs/account-portal/disable-account-portal.mdx

-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: Disabling the Account Portal
33
description: Learn how to disable the Account Portal.
44
---
55

6-
# Disabling the Account Portal
7-
86
If you would like to disable the Account Portal, in the Clerk Dashboard, go to the **[Account Portal](https://dashboard.clerk.com/last-active?path=account-portal)** page and then open the **Danger** tab. Please ensure that you set up an authentication flow for your users via the instructions below first, as applying this setting will immediately result in a 404 for all Account Portal pages.
97

108
<Callout type="danger">

Diff for: docs/account-portal/getting-started.mdx

-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: Getting started with the Account Portal
33
description: The Account Portal offers a comprehensive solution for managing user authentication and profile management in your web application and is the fastest way to add Clerk's authentication to your application with minimal code required.
44
---
55

6-
# Getting started with the Account Portal
7-
86
To integrate the Account Portal into your application, simply follow one of our [quickstart guides](/docs/quickstarts/overview).
97

108
Once your application is set up, all you have to do is fire it up. Clerk will automatically redirect your users to the Account Portal sign-in/sign-up pages. Once a user has successfully authenticated themself, they will be automatically redirected back to your application with an active session.

Diff for: docs/account-portal/overview.mdx

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
---
2-
title: Account Portal Overview
2+
title: Account portal overview
33
description: The Account Portal offers a comprehensive solution for managing user authentication and profile management in your web application and is the fastest way to add Clerk's authentication to your application with minimal code required.
44
---
55

6-
# Account portal overview
7-
86
The Account Portal in Clerk is a powerful feature that allows you to streamline the sign-in, sign-up, and profile management experience for your users, without having to build your own components or host your own pages.
97

108
<Images

Diff for: docs/account-portal/user-profile-org-profile.mdx

-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: User & Organization Pages
33
description: In addition to the sign-in/sign-up pages, the Account Portal also provides the User Profile, Organization Profile and Create Organization flow out of the box.
44
---
55

6-
# User & Organization Pages
7-
86
In addition to the sign-in/sign-up pages, the Account Portal also provides the User Profile, Organization Profile, and Create Organization pages out of the box.
97

108
You can use Clerk's Control Components to navigate your users to the appropriate page.

Diff for: docs/advanced-usage/clerk-idp.mdx

-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: Use Clerk as an OAuth 2 Provider
33
description: Learn how to use Clerk to facilitate Single Sign-On (SSO) with other clients that support the OAuth 2.0 protocol.
44
---
55

6-
# Use Clerk as an OAuth 2 Provider
7-
86
Learn how to use Clerk to facilitate Single Sign-On (SSO) with other clients that support the OAuth 2.0 protocol.
97

108
<Images

Diff for: docs/advanced-usage/satellite-domains.mdx

-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: Adding satellite domains
33
description: Learn how to share sessions across different domains by adding satellite domains to your application.
44
---
55

6-
# Adding satellite domains
7-
86
Clerk supports sharing sessions across different domains by adding one or many satellite domains to an application.
97

108
Your "primary" domain is where the authentication state lives, and satellite domains are able to securely read that state from the primary domain, enabling a seamless authentication flow across domains.

Diff for: docs/advanced-usage/using-proxies.mdx

-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: Proxying the Clerk Frontend API
33
description: Learn how to proxy the Clerk Frontend API through your domain.
44
---
55

6-
# Proxying the Clerk Frontend API
7-
86
Clerk supports two configuration methods for connecting to the Clerk Frontend API: CNAME and Proxy.
97

108
The recommended way to connect to the Clerk Frontend API is to [set up CNAME records and use DNS](/docs/deployments/overview). However, if you're unable to use this approach, or would like more control over your integration with Clerk, you can use a proxy.

Diff for: docs/authentication/configuration/email-sms-templates.mdx

-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: Email and SMS templates
33
description: Learn how to configure the theming of Clerk-sent emails and SMS messages.
44
---
55

6-
# Email and SMS templates
7-
86
Clerk provides a templating system that allows you to customize the default system email and SMS messages sent during authentication flows.
97

108
The template editor enables you to change the wording and styling so that it is more consistent with your own branding.

Diff for: docs/authentication/configuration/restrictions.mdx

-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: Restrictions
33
description: Learn how to manage user access to your application by configuring Clerk's access restrictions.
44
---
55

6-
# Restrictions
7-
86
Clerk provides restriction options that give you enhanced control over who can access your application. These options enable you to limit sign-ups or prevent accounts with specific [identifiers](/docs/authentication/configuration/sign-up-sign-in-options#identifiers), such as email address, from accessing your application.
97

108
There are two main types of restrictions available:

Diff for: docs/authentication/configuration/session-options.mdx

-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: Session options
33
description: Clerk provides session management options for fine-tuning user visits to your application.
44
---
55

6-
# Session options
7-
86
Clerk provides session management options for fine-tuning user visits to your application, including options for session lifetime, multi-session handling, and session token customization.
97

108
## Session lifetime

Diff for: docs/authentication/configuration/sign-up-sign-in-options.mdx

-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: Sign-up and sign-in options
33
description: Clerk provides various options for setting up a sign-up and sign-in flow.
44
---
55

6-
# Sign-up and sign-in options
7-
86
Clerk provides various options for setting up a sign-up and sign-in flow. When a new application is created, you will be presented with the following application configuration screen:
97

108
<Images

Diff for: docs/authentication/overview.mdx

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
---
2-
title: Sign-up & Sign-in Overview
2+
title: Overview
33
description: Learn how to configure authentication and user management for your Clerk application.
44
---
55

6-
# Overview
7-
86
Clerk supports multiple authentication strategies so that you can implement the strategy that makes sense for *your* users. You can use Clerk's [Account Portal](/docs/account-portal/overview), [pre-built components](/docs/components/overview), or [build your own custom flows](/docs/custom-flows/overview).
97

108

Diff for: docs/authentication/saml/account-linking.mdx

-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: Account Linking
33
description: Learn how Clerk handles account linking during SAML SSO.
44
---
55

6-
# Account Linking
7-
86
Account Linking is a process that Clerk uses to ensure a smooth sign-in and sign-up experience using SAML SSO and other methods (e.g. username/password). By using the email address as the common identifier, Clerk automatically attempts to link accounts whenever possible. Account linking triggers when a SAML provider returns an email address that matches an existing account, assuming a single owner for each email address.
97

108
## How it works

Diff for: docs/authentication/saml/authentication-flows.mdx

-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: SAML SSO authentication flows
33
description: Learn about the SAML SSO authentication flows.
44
---
55

6-
# SAML SSO authentication flows
7-
86
The SAML protocol supports two different methods in order to start an SSO flow: SP-initiated and IdP-initiated. This guide will explore the differences between the two.
97

108
## SP-initiated flow (recommended)

Diff for: docs/authentication/saml/azure.mdx

-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: Use Microsoft Azure AD for SAML SSO
33
description: Learn how to integrate Microsoft Azure AD with Clerk using SAML SSO.
44
---
55

6-
# Use Microsoft Azure AD for SAML SSO
7-
86
<TutorialHero
97
beforeYouStart={[
108
{

Diff for: docs/authentication/saml/custom-provider.mdx

-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: Use a custom Identity Provider for SAML SSO
33
description: Learn how to integrate an Identity Provider with Clerk using SAML SSO.
44
---
55

6-
# Use a custom Identity Provider for SAML SSO
7-
86
<TutorialHero
97
beforeYouStart={[
108
{

Diff for: docs/authentication/saml/google.mdx

-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: Use Google Workspace for SAML SSO
33
description: Learn how to integrate Google Workspace with Clerk using SAML SSO.
44
---
55

6-
# Use Google Workspace for SAML SSO
7-
86
<TutorialHero
97
beforeYouStart={[
108
{

Diff for: docs/authentication/saml/okta.mdx

-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: Use Okta Workforce for SAML SSO
33
description: Learn how to integrate Okta Workforce with Clerk using SAML SSO.
44
---
55

6-
# Use Okta Workforce for SAML SSO
7-
86
<TutorialHero
97
beforeYouStart={[
108
{

Diff for: docs/authentication/saml/overview.mdx

-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: Enterprise SSO via SAML
33
description: Clerk supports Enterprise SSO via the SAML protocol so that you can create authentication strategies for Identity Providers, such as Okta.
44
---
55

6-
# Enterprise SSO via SAML
7-
86
Clerk supports Enterprise SSO via the SAML protocol, enabling you to create authentication strategies for an Identity Provider (IdP). With Enterprise SSO, users can sign in seamlessly using their IdP's credentials and have their user data synchronized with Clerk. You can learn more about the process in the [SAML SSO authentication flows](/docs/authentication/saml/authentication-flows) and [Account linking](/docs/authentication/saml/account-linking) guides, or you can jump straight into integrating an IdP with Clerk. Currently, Clerk offers direct integrations with [Microsoft Azure AD](/docs/authentication/saml/azure), [Google Workspace](/docs/authentication/saml/google), and [Okta Workforce](/docs/authentication/saml/okta) as IdPs. However, you can also [integrate with any other IdP](/docs/authentication/saml/custom-provider) that supports the SAML protocol.
97

108
## Sync user attributes during sign in

Diff for: docs/authentication/social-connections/account-linking.mdx

-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: Account Linking
33
description: Learn how Clerk handles account linking and manages unverified email addresses from OAuth providers.
44
---
55

6-
# Account Linking
7-
86
Account Linking is a process used by Clerk to ensure a smooth sign-in and sign-up experience using both OAuth and other methods (e.g. username/password). By using the "email address" as the common identifier, Clerk aims to merge accounts whenever possible. This mechanism is triggered when an OAuth provider returns an email address that matches an existing account, assuming a single owner for each email address.
97

108
## How it works

Diff for: docs/authentication/social-connections/apple.mdx

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
---
1+
---
22
title: Apple
33
description: Learn how to set up social connection with Apple.
44
---
55

6-
# Apple
7-
86
How to set up social connection with Apple
97

108
## Overview

Diff for: docs/authentication/social-connections/atlassian.mdx

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
---
1+
---
22
title: Atlassian
33
description: Learn how to set up social connection with Atlassian.
44
---
55

6-
# Atlassian
7-
86
How to set up social connection with Atlassian
97

108
## Overview

Diff for: docs/authentication/social-connections/bitbucket.mdx

-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: Bitbucket
33
description: Learn how to set up social connection with Bitbucket.
44
---
55

6-
# Bitbucket
7-
86
How to set up social connection with Bitbucket
97

108
## Overview

Diff for: docs/authentication/social-connections/box.mdx

-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: Box
33
description: Learn how to set up social connection with Box.
44
---
55

6-
# Box
7-
86
How to set up social connection with Box
97

108
## Overview

Diff for: docs/authentication/social-connections/coinbase.mdx

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
---
1+
---
22
title: Coinbase
33
description: Learn how to set up social connection with Coinbase.
44
---
55

6-
# Coinbase
7-
86
How to set up social connection with Coinbase
97

108
## Overview

Diff for: docs/authentication/social-connections/discord.mdx

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
---
1+
---
22
title: Discord
33
description: Learn how to set up social connection with Discord.
44
---
55

6-
# Discord
7-
86
How to set up social connection with Discord
97

108
## Overview

Diff for: docs/authentication/social-connections/dropbox.mdx

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
---
1+
---
22
title: Dropbox
33
description: Learn how to set up social connection with Dropbox.
44
---
55

6-
# Dropbox
7-
86
How to set up social connection with Dropbox
97

108
## Overview

Diff for: docs/authentication/social-connections/facebook.mdx

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
---
1+
---
22
title: Facebook
33
description: Learn how to set up social connection with Facebook.
44
---
55

6-
# Facebook
7-
86
How to set up social connection with Facebook
97

108
## Overview

Diff for: docs/authentication/social-connections/github.mdx

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
---
1+
---
22
title: GitHub
33
description: Learn how to set up social connection with GitHub.
44
---
55

6-
# GitHub
7-
86
How to set up social connection with GitHub
97

108
## Overview

Diff for: docs/authentication/social-connections/gitlab.mdx

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
---
1+
---
22
title: GitLab
33
description: Learn how to set up social connection with GitLab.
44
---
55

6-
# GitLab
7-
86
How to set up social connection with GitLab
97

108
## Overview

Diff for: docs/authentication/social-connections/google.mdx

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
---
1+
---
22
title: Google
33
description: Learn how to set up social connection with Google.
44
---
55

6-
# Google
7-
86
How to set up social connection with Google
97

108
## Overview

Diff for: docs/authentication/social-connections/hubspot.mdx

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
---
1+
---
22
title: HubSpot
33
description: Learn how to setup social connection with HubSpot.
44
---
55

6-
# HubSpot
7-
86
How to set up social connection with HubSpot
97

108
## Overview

Diff for: docs/authentication/social-connections/line.mdx

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
---
1+
---
22
title: LINE
33
description: Learn how to set up social connection with LINE.
44
---
55

6-
# LINE
7-
86
How to set up social connection with LINE
97

108
## Overview

Diff for: docs/authentication/social-connections/linear.mdx

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
---
1+
---
22
title: Linear
33
description: Learn how to set up social connection with Linear.
44
---
55

6-
# Linear
7-
86
How to set up social connection with Linear
97

108
## Overview

Diff for: docs/authentication/social-connections/linkedin-oidc.mdx

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
---
2-
title: Set up a social connection with LinkedIn OpenID Connect
2+
title: LinkedIn OpenID Connect
33
description: Learn how to set up a social connection with LinkedIn in your Clerk application.
44
---
55

6-
# LinkedIn OpenID Connect
7-
86
<TutorialHero
97
beforeYouStart={[
108
{

Diff for: docs/authentication/social-connections/linkedin.mdx

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
---
1+
---
22
title: LinkedIn (Deprecated)
33
description: Learn how to set up social connection with LinkedIn.
44
---
55

6-
# LinkedIn (Deprecated)
7-
86
<Callout type="danger">
97
This page is now deprecated. Please see the new [guide](/docs/authentication/social-connections/linkedin-oidc) on how to set up a social connection with LinkedIn.
108
</Callout>

0 commit comments

Comments
 (0)