Skip to content

Update provider-specific info in custom domain docs #886

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 7, 2025
Merged

Update provider-specific info in custom domain docs #886

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d475301
add provider-specific settings section
ethanpalm Jul 7, 2025
5430d16
use accordions
ethanpalm Jul 7, 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
29 changes: 16 additions & 13 deletions settings/custom-domain.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,15 @@
To set up your documentation on a custom domain, you'll need to set your desired custom domain in your Mintlify settings and configure your DNS settings on your domain provider.

<Info>
Looking to set up a custom subdirectory like mintlify.com/docs? Find
instructions [here](/advanced/subpath/cloudflare).
Looking to set up a custom subdirectory like `mintlify.com/docs`? See the [custom subdirectory](/advanced/subpath/cloudflare) docs.
</Info>

## Dashboard Settings
## Dashboard settings

1. Head over to the [dashboard](https://dashboard.mintlify.com)
2. Click on "Settings".
3. Click on "Custom Domain".
4. Enter your desired custom domain. For example, `docs.mintlify.com`.
1. Navigate to your [dashboard](https://dashboard.mintlify.com)
2. Select **Settings**
3. Select **Domain Setup**
4. Enter your desired custom domain. For example, `docs.mintlify.com`

<Frame>
<img
Expand All @@ -31,10 +30,6 @@
/>
</Frame>

## Verification with Vercel

If Vercel happens to be your domain provider, you will have to add a verification `TXT` record. This information will show on your dashboard after submitting your custom domain, as well as be emailed to you.

## Configuring your DNS

1. Proceed to your domain's DNS settings on your domain provider's website.
Expand All @@ -48,6 +43,14 @@
<img alt="DNS" src="https://mintlify-assets.b-cdn.net/mintlify-dns.png" />
</Frame>

If you are using Cloudflare for your DNS provider, you'll need to have the “full strict” security option enabled for the https setting.
## Provider-specific settings

<AccordionGroup>
<Accordion title="Vercel verification">
If Vercel is your domain provider, you must add a verification `TXT` record. This information will show on your dashboard after submitting your custom domain, as well as be emailed to you.

Check warning on line 50 in settings/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/custom-domain.mdx#L50 

Did you really mean 'Vercel'?
</Accordion>

Please [contact support](mailto:support@mintlify.com) if you don't see the custom domain set up after the above configuration.
<Accordion title="Cloudflare security settings">
If Cloudflare is your DNS provider, you must enable the "full strict" security option for the https setting.
</Accordion>
</AccordionGroup>