From 922c838ef2a64d4418b043cd023ac3c6fafc395d Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 20 Oct 2025 20:47:31 +0000 Subject: [PATCH 1/2] Update customize/custom-domain.mdx --- customize/custom-domain.mdx | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/customize/custom-domain.mdx b/customize/custom-domain.mdx index ff5bf3f64..6bd2decb6 100644 --- a/customize/custom-domain.mdx +++ b/customize/custom-domain.mdx @@ -53,4 +53,30 @@ CNAME | docs | cname.vercel-dns.com. If Cloudflare is your DNS provider, you must enable the "full strict" security option for the https setting. - \ No newline at end of file + + +## Set a canonical URL + +After setting up your custom domain, you should set a canonical URL to ensure search engines index your preferred domain. A canonical URL tells search engines which version of your documentation is the primary one. This improves SEO when your documentation is accessible from multiple URLs and prevents issues with duplicate content. + +Add the `canonical` meta tag to your `docs.json`: + +```json +"seo": { + "metatags": { + "canonical": "https://www.your-custom-domain-here.com" + } +} +``` + +Replace `https://www.your-custom-domain-here.com` with your actual custom domain. For example, if your custom domain is `docs.mintlify.com`, you would use: + +```json +"seo": { + "metatags": { + "canonical": "https://docs.mintlify.com" + } +} +``` + +For more information about SEO configuration, see the [SEO documentation](/optimize/seo). \ No newline at end of file From 8708b8c6bebe28af4e07d0ca9634dac8020bf507 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 20 Oct 2025 13:54:44 -0700 Subject: [PATCH 2/2] copy edit --- customize/custom-domain.mdx | 30 ++++++++++++++---------------- 1 file changed, 14 insertions(+), 16 deletions(-) diff --git a/customize/custom-domain.mdx b/customize/custom-domain.mdx index 6bd2decb6..c9b85d576 100644 --- a/customize/custom-domain.mdx +++ b/customize/custom-domain.mdx @@ -4,7 +4,7 @@ description: "Host your documentation at your website's custom domain" og:description: "Host your documentation at your website's custom domain" --- -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. +To host your documentation on a custom domain, set your desired custom domain in your Mintlify settings and configure your DNS settings on your domain provider. Looking to set up a custom subdirectory like `mintlify.com/docs`? See the [custom subdirectory](/deploy/cloudflare) docs. @@ -12,52 +12,52 @@ To set up your documentation on a custom domain, you'll need to set your desired ## Dashboard settings -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` +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`. Custom Domain Custom Domain -## Configuring your DNS +## Configure your DNS -1. Proceed to your domain's DNS settings on your domain provider's website. -2. Create a new DNS entry, inputting the following values: +1. Navigate to your domain's DNS settings on your domain provider's website. +2. Create a new DNS entry with the following values: ```bash CNAME | docs | cname.vercel-dns.com. ``` - DNS + Sample CNAME settings for a custom domain hosted on Vercel. ## Provider-specific settings - 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. + If Vercel is your domain provider, you must add a verification `TXT` record. This information appears on your dashboard after submitting your custom domain, and is emailed to you. - If Cloudflare is your DNS provider, you must enable the "full strict" security option for the https setting. + If Cloudflare is your DNS provider, you must enable the "full strict" security option for the HTTPS setting. ## Set a canonical URL -After setting up your custom domain, you should set a canonical URL to ensure search engines index your preferred domain. A canonical URL tells search engines which version of your documentation is the primary one. This improves SEO when your documentation is accessible from multiple URLs and prevents issues with duplicate content. +After configuring your DNS, set a canonical URL to ensure search engines index your preferred domain. A canonical URL tells search engines which version of your documentation is the primary one. This improves SEO when your documentation is accessible from multiple URLs and prevents issues with duplicate content. Add the `canonical` meta tag to your `docs.json`: @@ -78,5 +78,3 @@ Replace `https://www.your-custom-domain-here.com` with your actual custom domain } } ``` - -For more information about SEO configuration, see the [SEO documentation](/optimize/seo). \ No newline at end of file