Skip to content
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

Jump to bottom

docs: Add TXT record setup step for custom domain configuration #372

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Add TXT record setup step for custom domain configuration #372

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
19 changes: 14 additions & 5 deletions mint.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,8 @@
},
{
"group": "Advanced",
"pages": [{
"pages": [
{
"icon": "code",
"group": "Custom Scripts",
"pages": [
Expand Down Expand Up @@ -196,7 +197,10 @@
},
{
"group": "SDKs",
"pages": ["integrations/sdks/speakeasy", "integrations/sdks/stainless"]
"pages": [
"integrations/sdks/speakeasy",
"integrations/sdks/stainless"
]
},
{
"group": "Support",
Expand All @@ -208,7 +212,10 @@
},
{
"group": "Privacy",
"pages": ["integrations/privacy/overview", "integrations/privacy/osano"]
"pages": [
"integrations/privacy/overview",
"integrations/privacy/osano"
]
},
{
"group": "Components",
Expand Down Expand Up @@ -240,7 +247,9 @@
},
{
"group": "Changelog",
"pages": ["changelog/overview"]
"pages": [
"changelog/overview"
]
}
],
"footer": {
Expand Down Expand Up @@ -324,4 +333,4 @@
"publicApiKey": "pk_76a6caa274e800f3ceff0b2bc6b9b9d82ab8"
}
}
}
}
17 changes: 15 additions & 2 deletions settings/custom-domain.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,19 @@ To set up your documentation on a custom subdomain, you'll need to set your desi

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.

## Domain Verification (Optional)

Some domain providers might require additional verification through a TXT record. If required:

1. Create a TXT record in your DNS settings
2. Use the following format:
```
Type: TXT
Name: @ or your subdomain
Value: [verification code provided by your domain provider]
```
The verification code will be specific to your domain and provider. If you're unsure whether this step is necessary, proceed to the DNS configuration below.

## Configuring your DNS

1. Proceed to your domain's DNS settings on your domain provider.
Expand All @@ -47,6 +60,6 @@ CNAME | docs | cname.vercel-dns.com.
<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.
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:[email protected]) if you don't see the custom subdomain set up after the above configuration.
Please [contact support](mailto:[email protected]) if you don't see the custom subdomain set up after the above configuration.