Skip to content

Revised custom domain page to be clear #408

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 1 commit into from
Dec 5, 2024
Merged

Revised custom domain page to be clear #408

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion mint.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@
},
{
"icon": "folder",
"group": "Custom Subpaths",
"group": "Custom Subdirectory",
"pages": [
"advanced/subpath/cloudflare",
"advanced/subpath/route53-cloudfront",
Expand Down
19 changes: 10 additions & 9 deletions settings/custom-domain.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,22 @@
---
title: 'Custom Domain'
description: "Host the documentation at your website's custom subdomain"
description: "Host your documentation at your website's custom domain"
icon: 'globe'
---

To set up your documentation on a custom subdomain, you'll need to set your desired custom subdomain in your Mintlify settings and configure your DNS settings on your domain provider.
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 domain like mintlify.com/docs? Find
Looking to set up a custom subdirectory like mintlify.com/docs? Find
instructions [here](/advanced/subpath/cloudflare).
</Info>

## Dashboard Settings

1. Head over to your [dashboard project](https://dashboard.mintlify.com)
2. Click on the "Add custom subdomain".
3. Enter your desired custom subdomain. For example, `docs.mintlify.com`.
1. Head over to your [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`.

<Frame>
<img
Expand All @@ -32,11 +33,11 @@ To set up your documentation on a custom subdomain, you'll need to set your desi

## 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 subdomain, as well as be emailed to you.
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.
1. Proceed to your domain's DNS settings on your domain provider's website.
2. Create a new DNS entry, inputting the following values:

```
Expand All @@ -49,4 +50,4 @@ CNAME | docs | cname.vercel-dns.com.

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

Please [contact support](mailto:sales@mintlify.com) if you don't see the custom subdomain set up after the above configuration.
Please [contact support](mailto:sales@mintlify.com) if you don't see the custom domain set up after the above configuration.
Loading